style: add // MAIN // section comment in @stdlib/constants/float16/{pi,half-pi,two-pi}#12158
Draft
Planeshifter wants to merge 3 commits into
Draft
style: add // MAIN // section comment in @stdlib/constants/float16/{pi,half-pi,two-pi}#12158Planeshifter wants to merge 3 commits into
// MAIN // section comment in @stdlib/constants/float16/{pi,half-pi,two-pi}#12158Planeshifter wants to merge 3 commits into
Conversation
…/pi` Add the `// MAIN //` section-comment marker separating the module documentation from the constant implementation in `lib/index.js` (present in 50 of 53, 94%, `@stdlib/constants/float16` members). `pi` was one of three members omitting the marker. The change adds a non-semantic source comment only; the exported value is unchanged.
…/half-pi` Add the `// MAIN //` section-comment marker separating the module documentation from the constant implementation in `lib/index.js` (present in 50 of 53, 94%, `@stdlib/constants/float16` members). `half-pi` was one of three members omitting the marker. The change adds a non-semantic source comment only; the exported value is unchanged.
…/two-pi` Add the `// MAIN //` section-comment marker separating the module documentation from the constant implementation in `lib/index.js` (present in 50 of 53, 94%, `@stdlib/constants/float16` members). `two-pi` was one of three members omitting the marker. The change adds a non-semantic source comment only; the exported value is unchanged.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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.
Resolves none.
Description
This pull request normalizes the
lib/index.jssource layout of three members of the@stdlib/constants/float16namespace —pi,half-pi, andtwo-pi— by adding the// MAIN //section-comment marker.stdlib source files delimit regions with section comments (
// MODULES //,// MAIN //,// EXPORTS //). In a@stdlib/constants/float16constant package,// MAIN //separates the module-level JSDoc from the constant implementation. 50 of 53 namespace members (94%) carry the marker;pi,half-pi, andtwo-piwere the three that omitted it. All three already carry the trailing// EXPORTS //marker, so the convention was partially applied and// MAIN //was the missing piece. The change adds a non-semantic source comment only — no exported value, signature, or test expectation changes.Namespace summary
@stdlib/constants/float16has no generated members).package.jsonshape (top-level /scripts/stdlibkeys), README section list and order,manifest.jsonshape, test/benchmark/example file naming.lib/index.jsstructure —'use strict';, JSDoc block shapes, section markers,require()dependencies, export form. These members are constant packages with nolib/main.jsorlib/validate.js, so the routine's public-signature / validation-prologue / error-construction fields are not applicable.package.jsontop-level keys (100%), emptyscripts(100%), README## Usage/#### <NAME>/## Examples(100%),test/test.jsandexamples/index.jsnaming (100%),'use strict';(100%), module-level JSDoc tag sequence (100%),// EXPORTS //marker (100%),// MAIN //marker (94%).@seetag count (mode 55%, content-driven by how many external references a constant has);manifest.json+ C header +## C APIssection (28%, the C-enabled bit/exponent constants — an intentional bimodal split, not drift);## See Alsosection (25%, auto-populated).Related Issues
None.
Questions
No.
Other
Each outlier is a separate commit.
@stdlib/constants/float16/pipiomitted the// MAIN //section comment present in 94% of namespace siblings. The marker now separates the module documentation from the constant implementation inlib/index.js. Comment-only change; the exported value3.140625is untouched.@stdlib/constants/float16/half-pihalf-piomitted the// MAIN //section comment present in 94% of namespace siblings. The marker now separates the module documentation from the constant implementation inlib/index.js. Comment-only change; the exported value1.5703125is untouched.@stdlib/constants/float16/two-pitwo-piomitted the// MAIN //section comment present in 94% of namespace siblings. The marker now separates the module documentation from the constant implementation inlib/index.js. Comment-only change; the exported value6.28125is untouched.Validation
package.json/manifest.jsonshape, README section structure, and test/example/benchmark file naming were extracted across all 53 members. No structural drift: every member carries the same 8-file layout and identicalpackage.jsonkey set.lib/index.jsstructure was extracted for all 53 members ('use strict';, JSDoc blocks/tags, section markers, dependencies, export form). The only majority feature with outliers was the// MAIN //marker.confirmed-driftfor all three outliers.@seetag-count variation (content-driven, no majority); themanifest.json/## C APIsC-binding split (intentional, 28%); the auto-populated## See Alsosection; anddocs/repl.txt/docs/types/*.d.ts(generator-owned). No outlier's tests or examples depend on the change.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored end-to-end by Claude Code running an automated cross-package drift-detection routine. The
@stdlib/constants/float16namespace was selected at random; structural and semantic features were extracted from all 53 members; the majority pattern per feature was computed at a 75% threshold; and the single drift finding (the// MAIN //marker) was validated by three independent review agents before any change was applied. A maintainer should audit the diff before promoting this draft.@stdlib-js/reviewers
Generated by Claude Code