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

documentation: move 32/64/native literals out of the extension chapter #2007

Merged
merged 1 commit into from Aug 27, 2018

Conversation

Projects
None yet
2 participants
@Octachron
Copy link
Contributor

commented Aug 26, 2018

This PR proposes to move the documentation for 32-bit, 64-bit and native integer literals to the main part of the manual. More precisely, the description of these literals in refman/exten.etex is moved to refman/const.etex and refman/lex.etex. Moreover, the description of int32, int64 and nativeint now mentions the existence of those literals in both the standard library documentation and the small section on built-in types.

@gasche

gasche approved these changes Aug 27, 2018

Copy link
Member

left a comment

Approved, but see minor typo in comments.

@@ -9,6 +9,9 @@
\begin{syntax}
constant:
integer-literal
| int32-literal
| int64-literal
| native-literal

This comment has been minimized.

Copy link
@gasche

gasche Aug 27, 2018

Member

This should be nativeint-literal

This comment has been minimized.

Copy link
@Octachron

Octachron Aug 27, 2018

Author Contributor

Fixed, thanks!

@@ -103,6 +103,7 @@ type int32
\index{int32@\verb`int32`}
\begin{ocamldocdescription}
The type of signed 32-bit integers.
Literals for 32-bit integers are suffixed by l.

This comment has been minimized.

Copy link
@gasche

gasche Aug 27, 2018

Member

This needs not be part of this PR, but it would be user-friendly to give examples of literal values at each of those described types: (), Exit, [1; 2; 3], Some true, 1l, -1l, etc.

This comment has been minimized.

Copy link
@Octachron

Octachron Aug 27, 2018

Author Contributor

It sounds like a good idea, but for a separate PR.

@Octachron Octachron force-pushed the Octachron:nme_integers branch 2 times, most recently from 6f59590 to e407ab3 Aug 27, 2018

documentation: promote 32/64/native literals
* Move the description of these literals to refman/const.etex and
refman/lex.etex
* Mention their existence in library/builtins.etex
* Add examples to Int32, Int64 and NativeInt module documentation

@gasche gasche merged commit 6744597 into ocaml:trunk Aug 27, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

gasche added a commit that referenced this pull request Aug 27, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.