Copy the argument documentation from source code to README #13
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
The documentation of arguments in the source code seems to be more current, so we should use that one in the README, too.
|
Hi Sebastian, I agree the duplication is not great, but I prefer the wording in the README as user-facing documentation. I think I'll just remove the details in the code comments and instead point to the README for details, to avoid maintenance headaches. |
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.
Like I've already mentioned in my previous pull request, I believe it makes more sense to really just copy & paste the text form the source code to the README so that you only have to maintain it at one place and just copy it over when it changes in the future.
I'm aware this pull request will conflict with your recent changes to README, but you could just take my file as-is.