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

Make config documentation user-accessible #31

Open
afmagee42 opened this issue Aug 15, 2024 · 0 comments
Open

Make config documentation user-accessible #31

afmagee42 opened this issue Aug 15, 2024 · 0 comments
Assignees
Labels
documentation Pertains to documentation (including API)

Comments

@afmagee42
Copy link
Collaborator

          I am not a fan of the way we're interleaving important information about the config with code. Since these are comments in code, it's relatively hidden.

I would prefer we either make a separate md in docs/ describing this, or move it into accessible docstrings. My preference would be a separate static md, unless we can figure out how to make mkdocs stop printing a very hard-to-read dictionary.

Originally posted by @afmagee42 in #28 (comment)

@afmagee42 afmagee42 added the documentation Pertains to documentation (including API) label Dec 16, 2024
@afmagee42 afmagee42 self-assigned this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pertains to documentation (including API)
Projects
None yet
Development

No branches or pull requests

1 participant