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

Doc - Fix formatting of functions table #134

Merged
merged 1 commit into from Jul 20, 2017
Merged

Conversation

quenio
Copy link
Contributor

@quenio quenio commented Jan 23, 2016

The second half of this table was being displayed as a paragraph.

The second half of this table was being displayed as a paragraph.
@quenio quenio changed the title Fix formatting of functions table Doc - Fix formatting of functions table Jan 23, 2016
|`<strlen(attr)>`|Return the length of a string attribute; runtime error if not string.|
|`<last(attr)>`|The last or only element of attr.|
|`<rest(attr)>`|All but the first element of attr. Returns nothing if <attr> is single valued.|
|`<reverse(attr)>`|Return a list with the same elements as v but in reverse order. null values are NOT stripped out. Use reverse(strip(v)) to do that.|
Copy link
Member

Choose a reason for hiding this comment

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

💡 Consider the following:

  • Replace v with attr in the description. There are two instances in this line, and a few similar cases in other descriptions in the table.
  • Either capitalize 'Null' or change it to null.
  • Use inline code for reverse(strip(attr)). The same situation occurs in a few other descriptions as well.

@sharwell
Copy link
Member

This change does fix the formatting, so 👍 from me. If you want to address them at the same time, I left a few notes regarding some additional cleanup that would improve the documentation (IMO).

@sharwell sharwell merged commit 3ee2d1d into antlr:master Jul 20, 2017
@parrt parrt added this to the 4.0.9 milestone Nov 7, 2018
@parrt parrt removed the code review label Nov 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants