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

Improve chapter 4 "The Programming Language" of the reference manual #4547

Merged
merged 2 commits into from
Aug 28, 2021

Conversation

fingolfin
Copy link
Member

No description provided.

@fingolfin fingolfin added the topic: documentation Issues and PRs related to documentation label Jun 7, 2021
<Item>function literals (see section&nbsp;<Ref Sect="Function"/>),</Item>
<Item>function calls (see section&nbsp;<Ref Sect="Function Calls"/>),</Item>
<Item>integer literals (see chapter&nbsp;<Ref Chap="Integers"/>),</Item>
<Item>floating point literals (see chapter&nbsp;<Ref Chap="Floats"/>),</Item>
Copy link
Member Author

@fingolfin fingolfin Jun 7, 2021

Choose a reason for hiding this comment

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

note that floats were missing in the list before this PR

<Item></Item>
</Row>
<Row>
<Item>&nbsp;&nbsp;&nbsp;&nbsp;<C>^</C></Item>
Copy link
Member Author

Choose a reason for hiding this comment

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

I am abusing non breaking spaces here to force the tables to look not too bad, as a workaround for lack in GAPDoc of a way to merge table cells (something like HTML's colspan attribute for tables) 😞

Copy link
Member

Choose a reason for hiding this comment

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

So your purpose is to achieve a kind of indentation. For those other reviewers interested in how this looks when rendered, here are the HTML and PDF versions, respectively:
Screenshot 2021-06-29 at 09 36 48
Screenshot 2021-06-29 at 09 37 06

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. I actually updated it further now:
Screenshot 2021-07-03 at 00 30 20

Copy link
Member

Choose a reason for hiding this comment

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

Great, I like it.

Copy link
Member

@wilfwilson wilfwilson left a comment

Choose a reason for hiding this comment

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

Just had a quick look. The precedence table is a very nice addition.

doc/ref/language.xml Outdated Show resolved Hide resolved
<Item></Item>
</Row>
<Row>
<Item>&nbsp;&nbsp;&nbsp;&nbsp;<C>^</C></Item>
Copy link
Member

Choose a reason for hiding this comment

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

So your purpose is to achieve a kind of indentation. For those other reviewers interested in how this looks when rendered, here are the HTML and PDF versions, respectively:
Screenshot 2021-06-29 at 09 36 48
Screenshot 2021-06-29 at 09 37 06

doc/ref/language.xml Outdated Show resolved Hide resolved
@fingolfin fingolfin marked this pull request as ready for review July 2, 2021 22:30
@fingolfin
Copy link
Member Author

Any more thoughts on this, @wilfwilson ?

Copy link
Member

@wilfwilson wilfwilson left a comment

Choose a reason for hiding this comment

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

Nice and simple, and a good improvement, thanks. I will merge when the tests pass again.

<Item></Item>
</Row>
<Row>
<Item>&nbsp;&nbsp;&nbsp;&nbsp;<C>^</C></Item>
Copy link
Member

Choose a reason for hiding this comment

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

Great, I like it.

doc/ref/language.xml Outdated Show resolved Hide resolved
- turned list of "basic" expressions into an actual list
- made the references in that list better
- add a table listing the precedence and associativity of various operators
- turned sections discussing various kinds of statements into subsections
  of the "Statements" section
Before it was listed under "Statements", even though it describes an
expression (a literal, to be precise).
@wilfwilson wilfwilson merged commit 3259d69 into gap-system:master Aug 28, 2021
@fingolfin fingolfin deleted the mh/doc-language branch August 28, 2021 20:22
@fingolfin fingolfin added the release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes label Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants