[FIX] Grammar and Consistency#95
Closed
Sir-NoChill wants to merge 5 commits into
Closed
Conversation
Correct ~20 single-word spelling/grammar errors across the spec and impl prose (e.g. writting->writing, preceeding->preceding, undecideable->undecidable, accomodate->accommodate, propogation->propagation, be reference->by reference). Also align two terminology slips with the surrounding text: refer to stream_state as a procedure (it is declared as one) and to the struct type as Another (its declared name). No semantic changes.
Correct mistakes in example snippets that would mislead readers: the tuple type in errors.rst (integerm integer -> integer, integer), an undefined identifier in string.rst (carry -> carray), a run-on comment (Run-timeerror -> Runtime error), and an erroneously escaped block-comment terminator in matrix.rst (\*/ -> */).
Demote two headings that were marked at the wrong level: the Variable Declarations subsection in globals.rst was underlined as a top-level title (same as the page heading), and Syntax Errors in errors.rst used a deeper underline than its sibling category Compile-time Errors. Both are now second-level headings, matching the surrounding structure.
Use the canonical bracket-chained form everywhere for 2D types and indexing, matching the rest of the matrix documentation: integer[3,3] -> integer[3][3] (expressions), real[3,3] -> real[3][3] (functions), and the M[1, 2] index comment -> M[1][2] (matrix). The comma form was used in only these three places and is inconsistent with the [*][*] / M[i][j] notation defined elsewhere.
Resolve three dangling references. The ssec:errors_sizeErrors label is never defined anywhere in the spec, so remove the two sentences that point to it (in array.rst and errors.rst); the surrounding text already states that SizeError may be raised at compile time or run time. Fill in the empty reference in type_promotion.rst to point at the type-casting section (sec:typeCasting), which defines the conversion semantics being referred to.
Sir-NoChill
changed the title
Collaborator
Author
|
Note that there are some duplicates from @novo52 in the 2026 changes, I'll cherry pick that commit and put it on here so that we can get things moving. |
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
1 participant
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.
Some small fixes while I go through the spec. These are pulled out of my other PR.