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

Fixes #598: add-index-entries #599

Merged
merged 2 commits into from
Apr 29, 2020
Merged

Fixes #598: add-index-entries #599

merged 2 commits into from
Apr 29, 2020

Conversation

KSchopmeyer
Copy link
Contributor

@KSchopmeyer KSchopmeyer commented Apr 28, 2020

Adds index entries for:

  1. command groups to commands

  2. commands to command groups

  3. general options

  4. the major modes (interactive, command)

  5. the components of the command line

I learned in writing a couple of books that creating an index is an endless task since you are trying to figure out what things the user looks for based on relationships to other parts of the document or words that might have meaning to the user.. So we can only take on some limited items, like indexing the sections with keywords, relating commands/groups etc.

I suggest that this is just a start but enough to consider committing.

Adds index entries for:

1. command groups to commands

2. commands to command groups

3. general options

4. the major modes (interactive, command)

5. the components of the command line
@KSchopmeyer KSchopmeyer added this to the 0.7.0 milestone Apr 28, 2020
@KSchopmeyer KSchopmeyer self-assigned this Apr 28, 2020
@coveralls
Copy link

coveralls commented Apr 28, 2020

Coverage Status

Coverage remained the same at 90.784% when pulling 1b47cf7 on ks/#598-add-to-doc-index into e546f56 on master.

Copy link
Contributor

@andy-maier andy-maier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments

@andy-maier andy-maier changed the title fixes issue #598-add-index-entries Fixes #598: add-index-entries Apr 29, 2020
corrections to ..index formatting issues
@andy-maier andy-maier merged commit 6f959f6 into master Apr 29, 2020
@andy-maier andy-maier deleted the ks/#598-add-to-doc-index branch April 29, 2020 15:22
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

Successfully merging this pull request may close these issues.

3 participants