Better docs #10
Open
Better docs #10
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
Manually maintaining SEE ALSO is too error prone. When 'kingst-la' was added, no manpage was properly updated. So, remove SEE ALSO for now. When we somewhen install sigrok-util properly, we can autogenerate this section. But we should first discuss if SEE ALSO is really useful. Signed-off-by: Wolfram Sang <[email protected]>
In general, the idea of having a README is nice so people can get easily information when browsing the repo in github. However, it is error-prone because it requiers a manual step to have the README and manpage always in sync. Even if we agree to have READMEs, they should be done for all firmware tools and, thus, the generation would need a different approach. Let's keep things consistent for now. Signed-off-by: Wolfram Sang <[email protected]>
|
Full ACK for the removal of the redundant text file when the groff source is committed. This has gone away in mainline in the meantime. Not sure about the SEE ALSO removal. Mainline fixed (and kept!) the SEE ALSO references. I'll leave it to a maintainer to either drop them or to auto generated them as wsa suggests. |
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.
When reviewing the kingst-la changes, I came up with these improvements to keep the docs error-free