Doc: use conventional comment style in JavaScript examples#2320
Open
smorimoto wants to merge 1 commit into
Open
Doc: use conventional comment style in JavaScript examples#2320smorimoto wants to merge 1 commit into
smorimoto wants to merge 1 commit into
Conversation
Use the more conventional spaced form `// Provides:` (instead of `//Provides:`) for runtime annotations, and `const` (instead of `var`) in the manual and `Js.Unsafe.runtime_value` JavaScript examples.
Member
Author
|
Related: ocamllabs/vscode-ocaml-platform#2162 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The manual consistently wrote runtime annotation comments without a space after
//(e.g.//Provides:), and a couple of JavaScript examples usedvar. This updates the documentation to a more conventional style:// Provides:(and// Requires:,// Version:, etc.) for runtime annotations. Both forms are accepted by the linker; the spaced form is more idiomatic for JavaScript comments.constinstead ofvarin the JavaScript examples.Only the documentation is touched (
manual/*.mld, theJs.Unsafe.runtime_valuedoc comment, and aCHANGES.mdentry). The runtime sources themselves are left unchanged.