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

§4.6: Amend Arrays Syntax Definition #60

Closed
2 tasks done
tajmone opened this issue Mar 1, 2020 · 2 comments
Closed
2 tasks done

§4.6: Amend Arrays Syntax Definition #60

tajmone opened this issue Mar 1, 2020 · 2 comments
Assignees
Labels
📋 Roody Notes From @roodyyogurt annotated PDF of Hugo Book 💀 code problems Problems with code examples or syntax definitions.
Projects
Milestone

Comments

@tajmone
Copy link
Owner

tajmone commented Mar 1, 2020

  • Get @tessman approval for these changes.
  • Fix document source.

Since it's a minor amend, there's no need to:

  • Annotate it in the source file.
  • Document the changes in CHANGES.md.
  • Document in ChangeLog.

In his annotated PDF, @roodyyogurt suggests that in §4.6. Arrays and Strings the space between <arrayname> and [<array size>] should be removed from the syntax definition:

array <arrayname> [<array size>]

This makes sense, for arrays are written in the form array test_array[10], as can be seen in the example immediately following the syntax definition.

@tajmone tajmone added 💀 text problems Text problems, typos or obsolete contents. 🕐 add to changes Contents changes that need to be documented 🕑 pending approval Issue requires approval by Ken Tessman 📋 Roody Notes From @roodyyogurt annotated PDF of Hugo Book labels Mar 1, 2020
@tajmone tajmone added this to the text fixes milestone Mar 1, 2020
@tajmone tajmone added this to To do in v1.1.0 via automation Mar 1, 2020
@tessman
Copy link
Collaborator

tessman commented Mar 7, 2020

That probably makes sense, yeah. It avoids making it look like some sort of additional/optional parameter, especially when you can compare it to an example.

@tajmone
Copy link
Owner Author

tajmone commented Mar 7, 2020

It avoids making it look like some sort of additional/optional parameter

In the upcoming release I'm planning to improve the Hugo syntax mock-ups styles by manually assigning different styles/colors to the various token indicating optionality ([]), alternatives (|) and omissions (...).

I had already planned these style improvements, which is the reason why the upcoming release bumps up the MINOR version (1.0.0 → 1.1.0), and not just the PATCH segment — because the added styles would require end user to update their custom templates to fully exploit the book, although is doesn't break backward compatibility.

See Issue #70 regarding this.

@tajmone tajmone added 💀 code problems Problems with code examples or syntax definitions. and removed 🕑 pending approval Issue requires approval by Ken Tessman 🕐 add to changes Contents changes that need to be documented 💀 text problems Text problems, typos or obsolete contents. labels Mar 7, 2020
tajmone added a commit that referenced this issue Mar 7, 2020
Remove the space between `<arrayname>` and `[<array size>]` from the
syntax definition:

    array <arrayname> [<array size>]

Since it's a minor change, no need to mention it in `CHANGES.md`.

(fixes #60)
@tajmone tajmone closed this as completed Mar 7, 2020
v1.1.0 automation moved this from To do to Done Mar 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Roody Notes From @roodyyogurt annotated PDF of Hugo Book 💀 code problems Problems with code examples or syntax definitions.
Projects
v1.1.0
  
Done
Development

No branches or pull requests

2 participants