Improve "docsgen" program's usability as a "template" #144
Conversation
This file contains hidden or 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
per1234
added
topic: documentation
The function that creates the Cobra CLI command root is declared by each project, and so might have any name. As it was the most advanced in general, I used Arduino Lint as the source for the Cobra-based project website template assets. However, I noticed that Arduino CLI and Arduino Firmware Uploader both use the function name `cli.NewCommand()`, so I think this is more likely to be the name used by tooling projects this template is applied to.
The function that creates the Cobra CLI command root is declared by each project, and so might have any name. The "docsgen" program that generates the command line reference content for the website calls this function, so it will be necessary for the appropriate function to be added to the program when it is added to a project. Previously, there was no documentation of this project-specific component of the "template", which could result in confusion when it was applied to a project that happens to have a different function name from the `cli.NewCommand()` used by the "template" docsgen code.
The template "docsgen" program for generating the website Cobra CLI reference content relies on the project's Cobra CLI package being named `cli`. But this is not guaranteed to be so, and in fact the Cobra documentation uses `cmd` instead. Confusion caused by applying the program to projects that use different package names will be avoided by specifying an explicit package name in the import statement.
umbynos
approved these changes
Aug 18, 2021
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.
I identified some project-specific aspects of the template "docsgen" program for generating the website Cobra CLI reference content. These are resolved, mitigated, or documented by this pull request.
See the individual commits for details:
https://github.com/arduino/tooling-project-assets/pull/144/commits