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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of AutoDoc field in PackageInfo.g #225

Open
fingolfin opened this issue Jul 22, 2019 · 1 comment
Open

Improve documentation of AutoDoc field in PackageInfo.g #225

fingolfin opened this issue Jul 22, 2019 · 1 comment
Labels
documentation Anything related to the documentation, including manual and README enhancement

Comments

@fingolfin
Copy link
Member

The current description of this in the AutoDoc manual is spares and incomplete, and also lacks an example. The language could also be improved.
@fingolfin fingolfin added enhancement documentation Anything related to the documentation, including manual and README labels Jul 22, 2019
@fingolfin
Copy link
Member Author

Among other things, the documentation for scaffold.TitlePage should point to the section describing the PackageInfo.g entry PkgInfo.AutoDoc.TitlePage, and vice-versa.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Anything related to the documentation, including manual and README enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fingolfin