-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
reviewed
Apr 29, 2020
andy-maier
requested changes
Apr 29, 2020
There was a problem hiding this 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
changed the title
fixes issue #598-add-index-entries
Fixes #598: add-index-entries
Apr 29, 2020
corrections to ..index formatting issues
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds index entries for:
command groups to commands
commands to command groups
general options
the major modes (interactive, command)
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.