-
Notifications
You must be signed in to change notification settings - Fork 0
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
Squash Glossary in Beta7 Dev Branch #55
Conversation
@thoni56, I've setup the Glossary in the Alan Manual, with a single initial entry (stropping) and various TODO entries commented out. If you have no objects to the contents changes it introduces (see below) I'd like to squash it into the This commit also introduces some contents changes to §4.2. Words, Identifiers and Names — as agreed, you'll be reviewing any contents changes before they are accepted into Manual. Once this is merged, we should delete the following work branches:
And then I'd like to polish the |
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.
As you have already noted and responded to, I had a few minor concerns about words and the introduction of the term "stropping". I'm all for the introduction of a glossary.
So consider the comments and then merge on your own discretion.
Ok, commit 22078d9 definitely mitigate the presence of the term "stropping" — it's no longer in the section title, and its occurrence was replaced with plain English, except in a couple of side notes which are there for informational purposes. As for the original idea of moving the "Escaping Single Quotes Inside Quoted Identifiers" note from the section Names Containing Multiple Words , I realized that the new text now clarifies it in the main body of the quoted IDs description, and it might be OK to leave that admonition there — for the context also includes We can always change it later if we think is better. Then, if it's OK with you to merge, I'd squash the new commits with original one, to keep the history unclattered, and then merge... |
First Glossary draft with an initial entry (*stropping*) and some commented-out pending entries TBD later on (Closes #54). Update contents of "§4.2. Words, Identifiers and Names": * Add "Stropping" sub-section. * Add `stropping` anchor. * Add `stropping` Index entry. * Revise and improve contents of this section: * More examples. * Extra admonitions. * Polish text. Clean-up, polish and update README files in Alan Manual directory. Referenced Issues: #36, #50, #54, asciidoctor/asciidoctor#3248.
22078d9
to
e31cd9b
Compare
First Glossary draft with an initial entry (stropping) and some
commented-out pending entries TBD later on (Closes #54).
Update contents of "§4.2. Words, Identifiers and Names":
stropping
anchor.stropping
Index entry.Clean-up, polish and update README files in Alan Manual directory.
Referenced Issues: #36, #50, #54, asciidoctor/asciidoctor#3248.