Commit Graph

143 Commits

Author SHA1 Message Date
Alessandro Coglio
df6c4d586c [ABNF] Use markdown in doc comments, and a few fixes.
By using markdown in the documentation comments of the grammar, the markdown
file generated from the grammar includes those markdown features in the text,
making it more readable and better-looking.

Also fixed a few typos in the documentation comments.

Also updated a few documentation comments that were out of date after making
changes to the grammar.

Also removed a now-obsolete grammar rule for "input" parameters of functions.
2021-04-21 22:33:52 -07:00
Alessandro Coglio
02f8736d03 [ABNF] Add some documentation.
For both uniformity and clarity of reference from other documentation comments,
add some documentation comments next to every single character definition.

No change to the grammar itself.
2021-04-21 21:56:27 -07:00
Alessandro Coglio
ac5ca5058a [ABNF] Edit some doc comments for consistency.
No change to the grammar, just some edits in comments.
2021-04-21 10:44:40 -07:00
Alessandro Coglio
e08d1f7f36 [ABNF] Move two rules and add some comments.
This does not change the grammar, just its presentation in the file.
2021-04-21 10:39:37 -07:00
Collin Chin
25cabe57e2
Merge branch 'master' into feature/abnf-doc-update 2021-04-21 08:46:01 -07:00
Alessandro Coglio
66664ed35c [ABNF] Regenerate the .md file. 2021-04-20 15:53:29 -07:00
Alessandro Coglio
964883a535 [ABNF] Add full copyright/licensing notice.
Make the change to the .txt file.
2021-04-20 15:52:08 -07:00
Alessandro Coglio
7cfa7d6a54 [ABNF] Move the format note to the end of the file.
Make this change on the .txt file.
2021-04-20 15:46:48 -07:00
collin
d5783bb0e0 fix license 2021-04-20 14:33:05 -07:00
collin
ce8f02eea0 Merge branch 'master' of https://github.com/AleoHQ/leo into feature/abnf-doc-update 2021-04-20 14:32:16 -07:00
collin
905c889a67 fix grammar readme 2021-04-20 14:25:12 -07:00
Alessandro Coglio
62932ceef2 [ABNF] Update documentation of format strings.
The documentation comments were out of date.
2021-04-19 23:24:43 -07:00
Collin Chin
543188049c
Move format note to bottom of abnf grammar 2021-04-16 12:30:58 -07:00
howardwu
4eac040178 chore(leo): bump version for new release 2021-04-15 13:49:42 -07:00
Collin Chin
08d37da2ef
Merge pull request #866 from AleoHQ/dependabot/cargo/abnf-0.11.3
Bump abnf from 0.10.2 to 0.11.3
2021-04-15 12:01:27 -07:00
collin
e98079fecf rename abnf enum 2021-04-15 11:57:52 -07:00
dependabot-preview[bot]
3bc90da57c
Bump abnf from 0.10.2 to 0.11.3
Bumps [abnf](https://github.com/duesee/abnf) from 0.10.2 to 0.11.3.
- [Release notes](https://github.com/duesee/abnf/releases)
- [Commits](https://github.com/duesee/abnf/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-04-15 10:29:26 +00:00
gluax
2f7ed99f76 pull max's required semi-colon branch to ensure sameness, MD file renamed to readme 2021-04-14 18:38:49 -04:00
gluax
6e595bd845 remove escaped double quote for now, address(...) removed 2021-04-14 17:43:02 -04:00
gluax
cf36a6bfe7 non-ambigious format strings, escaped double quotes allowed 2021-04-14 17:11:02 -04:00
gluax
1803925b08 semi-colon after return statements are required 2021-04-14 16:59:07 -04:00
gluax
bd9297499e trailing comma in circuit construction expression 2021-04-14 16:19:55 -04:00
gluax
124235c15d remove cast-expression from abnf for now 2021-04-14 16:17:57 -04:00
gluax
11c78da916 formatted string -> renamed format string 2021-04-14 16:15:27 -04:00
gluax
91634d6479 implicit input, removed from function input 2021-04-14 16:00:19 -04:00
Collin Chin
5b989db49d
Merge pull request #849 from AleoHQ/feature/exponentiation-associativity
[ABNF] Make ** right-associative.
2021-04-13 15:18:25 -07:00
howardwu
62ee4c3b8b chore(leo): bump version for new release 2021-04-09 14:08:52 -07:00
howardwu
34a719d5a5 Update metadata for grammar toml 2021-04-09 13:50:39 -07:00
howardwu
513c6f00ac Remove keyword from grammar toml 2021-04-09 13:49:11 -07:00
Alessandro Coglio
f26114afa5 [ABNF] Make ** right-associative.
As agreed on Slack.
2021-04-09 13:01:59 -07:00
damirka
45986d598c adds %s to abnf converter and md 2021-04-08 10:45:04 +03:00
Collin Chin
68419f4e10
Merge pull request #835 from AleoHQ/feature/abnf-doc-improvements
[ABNF] Improve the documentation of the grammar and fix a rule
2021-04-07 14:26:52 -07:00
Alessandro Coglio
d7d15b1bc4 [ABNF] Regenerate markdown file. 2021-04-06 16:41:12 -07:00
Alessandro Coglio
f19af30f0e [ABNF] Fix rule for affine group literals.
This was

affine-group-literal = "(" group-coordinate "," group-coordinate ")" %s"group"

instead of

affine-group-literal = "(" group-coordinate "," group-coordinate %s")group"

(note the different ending).

This change should have been part of the PR for whitespace in group literals,
but apparently I failed to do that, along with the other changes.

This commit rectifies that omission.
2021-04-06 16:39:07 -07:00
Alessandro Coglio
7da8a3c033 [ABNF] Improve consistency of documentation. 2021-04-06 16:37:18 -07:00
Alessandro Coglio
5f85308444 [ABNF] Improve the syntactic grammar section documentation.
Update some comments that were now out of date.

Clarify some text.

Fix some typos.
2021-04-06 16:35:47 -07:00
Alessandro Coglio
f0bac48093 [ABNF] Improve lexical grammar documentation.
Fix some typos, clarify some text, remove/update some obsolete references.
2021-04-06 16:03:28 -07:00
Alessandro Coglio
e035743f96 [ABNF] Improve naming convention section of documentation.
Some tweaks and some clarifications.
2021-04-06 15:19:41 -07:00
Collin Chin
e31bace4cb
Merge pull request #830 from AleoHQ/dependabot/cargo/abnf-0.10.2
Bump abnf from 0.10.1 to 0.10.2
2021-04-06 15:15:53 -07:00
Alessandro Coglio
fdaab572f9 [ABNF] Improve operator precedence section of documentation.
Fix a typo. Tweak some text layout.
2021-04-06 15:14:08 -07:00
Alessandro Coglio
11c0d60021 [ABNF] Improve structure section of documentation.
Make this more concise and clear by just presenting the lexical and syntactic
grammar as the way we define the Leo syntax, as opposed to discussing
alternatives like PEGs.
2021-04-06 14:59:52 -07:00
Alessandro Coglio
c7fb2905c0 [ABNF] Improve background section of documentation.
Explicate references to RFCs a bit.

Use the term 'sequence of terminals' instead of 'string' to avoid any confusion.

(Still use 'string' to refer to the actual strings in double quotes that are
part of the ABNF notation itself.)
2021-04-06 14:45:23 -07:00
Alessandro Coglio
742e3b33ea [ABNF] Improve introduction section of documentation.
Update to say that grammar is no longer just a draft.

Put primary motivation and purpose of grammar first.

Mention use in formalization second, and slightly simplify that part, given that
the formalization is not public yet.
2021-04-06 14:43:55 -07:00
Alessandro Coglio
48635e5dbe [ABNF] Fix typos in documentation. 2021-04-06 14:22:15 -07:00
dependabot-preview[bot]
751b42ab5b
Bump abnf from 0.10.1 to 0.10.2
Bumps [abnf](https://github.com/duesee/abnf) from 0.10.1 to 0.10.2.
- [Release notes](https://github.com/duesee/abnf/releases)
- [Commits](https://github.com/duesee/abnf/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2021-04-06 10:36:36 +00:00
Alessandro Coglio
880f2cd200 [ABNF] Remove explicit author info, as discussed. 2021-04-05 21:55:19 -07:00
Alessandro Coglio
797e8ceffd [ABNF] Tweak some layout.
Just for consistency with the rest of the file.
2021-04-05 21:54:18 -07:00
Alessandro Coglio
c0ea8798a2 [ABNF] Remove leftover reference.
This was uncovered by running the grammar through the ACL2 build: among other
things, the build checks that every nonterminal referenced in the right side of
each rule has a definition in the grammar.
2021-04-05 21:47:28 -07:00
Alessandro Coglio
5f875a4e93 [ABNF] Allow const self.
This still needed to be updated. The rules only supported self and mut self.
2021-04-05 21:27:37 -07:00
Collin Chin
9b9fe0b8c7
Merge pull request #822 from AleoHQ/dependabot/cargo/abnf-0.10.1
Bump abnf from 0.10.0 to 0.10.1
2021-04-05 21:13:23 -07:00