docs gate: the guard-state check reads a sentence across a Markdown block boundary and refuses a correct paragraph
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 83/100
- Type d'issue
- Bug
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- bash, c, markdown
- Domaine
- documentation, testing-qa, tooling
Piste de recherche
Commencez par tools/docs_claims_check.sh et ses cas d’auto-test, puis examinez comment la vérification de l’état de garde sépare les blocs de texte et les phrases Markdown. Exécutez bash tools/docs_claims_check.sh sur un arbre construit contenant le paragraphe d’exemple dans docs/BUILTINS.md ; le travail est terminé si la vérification réussit dans ce cas et si les affirmations concernant des arguments de type incorrect restent signalées comme erreurs aussi bien dans un paragraphe que dans une cellule de tableau.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
tools/docs_claims_check.sh judged a correct sentence about arithmetic results as a claim about opt-in argument guards, because the unit it reads as "a sentence" ran across a Markdown block boundary: it began in the table above the paragraph, whose last row has no full stop.
Found while writing #2444's documents. That change reflowed its paragraph and left the checker alone.
Shows it
In docs/BUILTINS.md, put this paragraph directly under the table of the "Command-Line Arguments" section (at the head of "Scalar Math"), and run bash tools/docs_claims_check.sh on a built tree:
Scalar arithmetic and its existing list forms accept infinity and NaN: with
`EIGS_STRICT` unset or `0`, the result follows IEEE 754 and C libm; with
`EIGS_STRICT=1`, a non-finite result raises through the existing arithmetic or
domain trap, while a finite result answers.
The gate is red at that line, although the paragraph says nothing about argument guards. Split into shorter sentences, the same statement passes.
Done when
- A heading, a table and a blank line end the unit of prose the guard-state check reads; a sentence does not begin in the block before.
- The paragraph above passes where it stands.
- A real statement that wrong-typed arguments are refused only under
EIGS_STRICT=1stays red, in a paragraph and in a table cell; both are self-test cases.
— Claude DevBox
- Langage dominant
- C
- Étoiles
- 3
- Forks
- 7
- Merge moyen
- 3 h 28 min
- PR mergées (30 j)
- 270
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de InauguralSystems/EigenScript
-
area:gates needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
InauguralSystems/EigenScript#2462 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
The hosted-RNG check refuses a clean tree that has a tracked file with a double quote in its nameOuvertearea:gates kind:gate-defect needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
InauguralSystems/EigenScript#2461 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
area:gates kind:gate-defect needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
InauguralSystems/EigenScript#2458 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
`http_post`: `headers` text with something after its JSON value now means no headers, without a wordOuvertearea:http kind:silent-wrong
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
InauguralSystems/EigenScript#2394 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
area:docs good first issue kind:docs-drift
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
InauguralSystems/EigenScript#2360 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de InauguralSystems/EigenScript
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
flipperdevices/flipperzero-firmware#4520 ·
Les mainteneurs répondent en général sous 1 jour
-
area/build-framework kind/enhancement priority/low
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
yugabyte/yugabyte-db#38826 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
meshcore-dev/MeshCore#3891 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
bug grammar sev-3
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
BUG/MEDIUM: regex: worker SIGSEGV when a regex is applied to an empty body on libc-regex buildsOuvertestatus: needs-triage type: bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100