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

Check documentation for default fields #11

Open
pi-sigma opened this issue Jul 10, 2024 · 0 comments
Open

Check documentation for default fields #11

pi-sigma opened this issue Jul 10, 2024 · 0 comments

Comments

@pi-sigma
Copy link
Contributor

pi-sigma commented Jul 10, 2024

The documentation for config variables corresponding to default model fields should be checked at some point. For example, the documentation for JSONField says the expected value is of the form 'some_key': 'Some value'}. This is not false, but there could be other values (int, list, None).

Can be taken up in the context of adding support for YAML config files or when corrections to the generate_docs functionality become necessary.

Additional things:

  • Add remark to documentation template (visible to the end user) that the docs are auto-generated
  • Add comment to documentation template (only visible to devs) that the docs should not be edited manually (to prevent "corrections" of spelling errors, stylistic errors etc., which need to be fixed elsewhere, e.g. on the models from which the documentation is pulled)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant