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

Auto-generate the file-level documentation from its contents #96

Open
fosterbrereton opened this issue Oct 16, 2024 · 0 comments
Open

Comments

@fosterbrereton
Copy link
Contributor

fosterbrereton commented Oct 16, 2024

The brief and owner fields in index.md for a class and the file that contains it should be inherited (somehow) from the class documentation itself. When there's a single class in a file, it seems silly to copy the brief and owner up to the index file(s).

Another option would be to make those fields __OPTIONAL__ if there's a single sub-entity in the file. No need to copy if it's just going to be redundant.

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