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

Submodules: default should not include them on the same page. #54

Closed
dbuenzli opened this issue Feb 6, 2015 · 1 comment
Closed

Submodules: default should not include them on the same page. #54

dbuenzli opened this issue Feb 6, 2015 · 1 comment
Labels
critical enhancement templates
Milestone
beta

Comments

@dbuenzli
Copy link
Contributor

dbuenzli commented Feb 6, 2015

I think that by default you should not include the documentation of submodules on the same page. Submodules are a natural way to chunk functionality and documentation in cognitively bite sized elements. All my documentation is designed around this principle, so currently it doesn't look good (in the sense you get annoyed by details you should not be annoyed with when you want to have a cusory look at the module).

Related to #4 and lpw25/opam-doc-base#70
@dsheets dsheets added this to the beta milestone Feb 6, 2015
@dsheets
Copy link
Owner

dsheets commented Feb 6, 2015

See also #6.

@dsheets dsheets mentioned this issue Feb 10, 2015
Open
@dsheets dsheets closed this as completed in ca3d4cc Sep 1, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
critical enhancement templates
Projects
None yet
Milestone
beta
Development

No branches or pull requests
2 participants
@dsheets @dbuenzli