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

Squash Glossary in Beta7 Dev Branch #55

Merged
merged 1 commit into from
Sep 1, 2019

Conversation

tajmone
Copy link
Collaborator

@tajmone tajmone commented Aug 30, 2019

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.

@tajmone tajmone requested a review from thoni56 August 30, 2019 13:37
@tajmone
Copy link
Collaborator Author

tajmone commented Aug 30, 2019

@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 beta7-prep branch as soon as possible, so we can get rid of the dev sub-branches and carry on with other contents updates — Alan Beta7 is approaching and there are still numerous fixes and updates to take care of before the Manual is on par with the upcoming Beta7.

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:

  • beta7-prep_glossary
  • beta7-prep_glossary-squash

And then I'd like to polish the AppG-i18n branch (on App. G: Localization) so we can squash that too (some paragraphs must be removed first, for I got wrong a couple of things there), and then I can move on to try and fix some of the pending issues marked as "required" for the Beta7 update.

@tajmone tajmone added 📖 Alan Manual Issues relating to "The Alan Language Manual" ⭐ glossary Topic: Document Glossary labels Aug 30, 2019
@tajmone tajmone added this to the Alan Beta7 milestone Aug 30, 2019
@tajmone tajmone mentioned this pull request Sep 1, 2019
5 tasks
manual/manual.html Outdated Show resolved Hide resolved
Copy link
Contributor

@thoni56 thoni56 left a 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.

@tajmone
Copy link
Collaborator Author

tajmone commented Sep 1, 2019

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 NAME clauses, and has wider implications than just IDs.

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.
@tajmone tajmone merged commit aeb8150 into beta7-prep Sep 1, 2019
@tajmone tajmone deleted the beta7-prep_glossary-squash branch September 1, 2019 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Alan Manual Issues relating to "The Alan Language Manual" ⭐ glossary Topic: Document Glossary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants