Skip to content

NIFI-4840 Fix formatting for expression language guide for toRadix an…#2449

Closed
Leah-Anderson wants to merge 1 commit intoapache:masterfrom
Leah-Anderson:NIFI-4840
Closed

NIFI-4840 Fix formatting for expression language guide for toRadix an…#2449
Leah-Anderson wants to merge 1 commit intoapache:masterfrom
Leah-Anderson:NIFI-4840

Conversation

@Leah-Anderson
Copy link
Copy Markdown

…d fromRadix

Thank you for submitting a contribution to Apache NiFi.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically master)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

*Description*: [.description]#Converts the Subject from a Base 10 number to a different Radix (or number base). An optional
second argument can be used to indicate the minimum number of characters to be used. If the converted value
has fewer than this number of characters, the number will be padded with leading zeroes.
has fewer than this number of characters, the number will be padded with leading zeroes.#
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that, instead of moving the # character, it'd be better to just remove the carriage return between this line and the next one, no? (same applies for fromRadix). Otherwise, the display is a bit weird in the doc:
https://github.com/Leah-Anderson/nifi/blob/a445ee4d141ea1218d3cf5c47abb5171c5890f43/nifi-docs/src/main/asciidoc/expression-language-guide.adoc#fromradix

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking the way it was made it seem like a call out to "hey this is important to note" but I can see it either way. I've pushed an update to remove the carriage return :)

Copy link
Copy Markdown
Contributor

@zenfenan zenfenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was also under the impression that the last line was made to be highlighted as sort of a 'note' to users. Just realized that's not the case by looking at the description of the others. The latest commit fixes it. LGTM

@pvillard31
Copy link
Copy Markdown
Contributor

+1, merging to master, thanks @Leah-Anderson @zenfenan

@asfgit asfgit closed this in a3edd34 Feb 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants