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.

Sign up for GitHub

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

Jump to bottom

Update and improve doc #2636

Merged
merged 16 commits into from
Jul 2, 2021
Merged

Update and improve doc #2636

merged 16 commits into from
Jul 2, 2021

Conversation

crusso
Copy link
Contributor

@crusso crusso commented Jun 30, 2021 •
edited
Loading

  • fix formatting of lots of broken operators (asciidoc gaslighting)
  • remove defunct avoidance clause on block typing;
  • fix formatting of function arrows.
  • mardown italics -> asciidoc italics
  • add links to base for each prim type
  • minor changes here and there
  • indent some bnf to avoid scrollbars
  • document new compiler options/regularlize description (we should really hide most of them)

I think the rich ASCII doc diff is too large for GH to handle, so many read

https://hydra.dfinity.systems/build/5455225/download/1/docs/language-guide/language-manual.html

side by side with this.

Or just approve it.

@dfinity-ci
Copy link

This PR does not affect the produced WebAssembly code.

@crusso crusso requested review from rossberg and ggreif July 1, 2021 14:19
@crusso crusso requested a review from osa1 July 1, 2021 14:35
@crusso crusso marked this pull request as ready for review July 1, 2021 14:35
@crusso crusso changed the title fix formatting of many operators; Update and improve doc Jul 1, 2021
osa1
osa1 approved these changes Jul 1, 2021
View reviewed changes
doc/modules/language-guide/pages/compiler-ref.adoc Outdated Show resolved Hide resolved
doc/modules/language-guide/pages/language-manual.adoc
| `+==+` | | equals
| `+!=+` | | not equals
| `␣<␣` | O | less than _(must be enclosed in whitespace)_
| `␣>␣` | O | greater than _(must be enclosed in whitespace)_
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we have ␣s here and in the prev line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As a way to indicate that the spaces are required. I'm open to better suggestions...

doc/modules/language-guide/pages/language-manual.adoc Show resolved Hide resolved
@crusso
Copy link
Contributor Author

crusso commented Jul 2, 2021

@rossberg PTAL

rossberg
rossberg reviewed Jul 2, 2021
View reviewed changes
Copy link
Contributor

@rossberg rossberg left a comment

Choose a reason for hiding this comment

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

Looks okay, but I can't claim that I understand the mark-up rules and what the difference is between single backtick, double backtick or backtick-plus.

Some comments on content we may want to fix while here.

doc/modules/language-guide/pages/compiler-ref.adoc Outdated Show resolved Hide resolved
doc/modules/language-guide/pages/language-manual.adoc Outdated Show resolved Hide resolved
@crusso crusso added the automerge-squash When ready, merge (using squash) label Jul 2, 2021
@mergify mergify bot merged commit e853d20 into master Jul 2, 2021
@mergify mergify bot deleted the claudio/doc-operators branch July 2, 2021 22:37
@mergify mergify bot removed the automerge-squash When ready, merge (using squash) label Jul 2, 2021
@crusso crusso mentioned this pull request Jul 6, 2021
Closed
@ggreif ggreif mentioned this pull request Jul 8, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rossberg rossberg rossberg left review comments

@osa1 osa1 osa1 approved these changes

@ggreif ggreif Awaiting requested review from ggreif

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@crusso @dfinity-ci @osa1 @rossberg