Fixes #8217: Broken syntax in generic methods docs #344
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This fix looks good but will come back to bite us if we don't detect it. Please add a test in tests/style to make sure this is always detected. |
|
PR updated |
amousset
force-pushed
the
bug_8217/broken_syntax_in_generic_methods_docs
branch
from
ee2d30c
to
66daf8f
Compare
|
PR updated |
amousset
force-pushed
the
bug_8217/broken_syntax_in_generic_methods_docs
branch
2 times, most recently
from
6cbc2c0
to
e5073f7
Compare
|
PR updated |
| @@ -24,8 +24,8 @@ | |||
| # | |||
| # @class_prefix file_check_block_device | |||
| # @class_parameter file_name | |||
| # This bundle will define a class file_check_block_device_${file_name}_{ok, reached, kept} if the | |||
| # file is a block_device, or file_check_block_device_${file_name}_{not_ok, reached, not_kept, failed} if | |||
| # This bundle will define a class `file_check_block_device_${file_name}_{ok, reached, kept}` if the | |||
There was a problem hiding this comment.
Shouldn't this line start with @documentation too?
There was a problem hiding this comment.
Indeed, the PR that added these methods was started before the changes in ncf docs, and merged after. I will make a separate ticket for these.
|
PR updated |
amousset
force-pushed
the
bug_8217/broken_syntax_in_generic_methods_docs
branch
from
e5073f7
to
c54f350
Compare
|
Looks good to me! I see you're still making changes, so let me know if you make another change I shuold review. Otherwise, go ahead and merge this version. |
|
I finished making changes, merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://www.rudder-project.org/redmine/issues/8217