This repository has been archived by the owner on Mar 26, 2020. It is now read-only.
Follow naming convention for parameter names in method docstrings #352
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.
The problem here is that if I have differing naming conventions in different languages then if I mention a method parameter name in my djinni docstring it will be wrong in at least one language (e.g.
some_parameter
in C++ butsomeParameter
in Obj-C and Java). And I will probably mention them if I'm using doxygen or javadoc (@param some_parameter
). Beyond being annoying, this causes warnings in XCode and probably other environments.The fix will run every method docstring through a series of regexes that replace each djinni parameter name with the corresponding name in the language naming convention.
Drawbacks
This is a fix for #332, which I opened.