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

Module docs: 2 suggestions... #5525

Closed
mark-summerfield opened this Issue Mar 14, 2017 · 2 comments

Comments

Projects
None yet
4 participants
@mark-summerfield
Copy link
Contributor

mark-summerfield commented Mar 14, 2017

(1) The title of each module in the docs should be written "module-name Module" not "Module module-name" since this puts the important information first.

(2) The Imports section's structure should be changed. For example if this were the threadpool module it should be:

Imports

import threadpool
Dependencies: cpuinfo, cpuload, locks

With the dependencies links as now of course.

@Araq

This comment has been minimized.

Copy link
Member

Araq commented Mar 14, 2017

(1) Or we remove the word "module" instead?
(2) I think the "Imports" word should be changed to "Dependencies" instead.

@mark-summerfield

This comment has been minimized.

Copy link
Contributor

mark-summerfield commented Mar 14, 2017

Yes I think both are the best things to do. I still suggest including import *modname* above the Dependencies if poss.

@Araq Araq added the Hacktoberfest label Oct 15, 2018

narimiran added a commit to narimiran/Nim that referenced this issue Oct 28, 2018

@Araq Araq closed this in 313bbf5 Oct 31, 2018

narimiran added a commit that referenced this issue Nov 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment