Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review documentation #108

Open
jpmckinney opened this issue May 28, 2021 · 1 comment
Open

Review documentation #108

jpmckinney opened this issue May 28, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jpmckinney
Copy link
Member

jpmckinney commented May 28, 2021

Need to review CLI option documentation (--help) https://open-contracting.github.io/spoonbill/cli.html#reference

We can also review the docstrings (lower priority) https://open-contracting.github.io/spoonbill/api.html

While reviewing the docstrings, we will likely end up reading the code. Anything we learn about the architecture that is worth noting can be added to the docstrings (e.g. the class docstrings can further describe their role in processing data and their relationship to other components).

@jpmckinney jpmckinney added the documentation Improvements or additions to documentation label Dec 15, 2021
@jpmckinney jpmckinney changed the title docs: Review Review documentation Dec 15, 2021
@jpmckinney
Copy link
Member Author

jpmckinney commented Dec 15, 2021

I had also made a note to try to use Click's show_default configuration to auto-document the defaults.

Noting that #124 added show_default, to avoid writing the defaults in the command's description, and then #125 removed it, because all the tests failed.

Also noting that #124 hardcodes some text like "OCDS 1.1.5" because #123 had used formatted strings instead of named placeholders, as required by gettext.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants