Skip to content

docs: normalize trailing newlines in REPL help texts - #16420

Merged
kgryte merged 1 commit into
developfrom
philipp/repl-help-eof
Nov 3, 2026
Merged

kgryte merged 1 commit into
developfrom
philipp/repl-help-eof

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

This pull request normalizes production REPL help files to exactly two trailing LF characters (\n\n), matching the existing scaffold templates and the dominant codebase convention for the empty See Also section.

  • Add one trailing newline to 790 files.
  • Remove one trailing newline from 10 files.
  • Leave the remaining 4,883 production help files unchanged.

All bytes preceding the final newline run and all file modes are preserved. Test fixtures are excluded.

Related Issues

None. This is a repository-wide documentation formatting cleanup.

Reference Packages

This follows the seven REPL scaffold templates under lib/node_modules/@stdlib/_tools/scaffold and the guidance in docs/contributing/repl_text.md.

The EOF format carried over unchanged from those templates; no package behavior or REPL examples were edited.

Questions

No.

Other

Validation:

  • Inspected all 5,683 production docs/repl.txt files on the base commit.
  • Verified that every production help file ends with exactly two LF characters after this change.
  • Verified byte-for-byte identity before the trailing newline run for every changed file and preservation of file modes.
  • Parsed all 800 changed files before and after normalization and verified equivalent ASTs, excluding source line positions and trailing newline padding.
  • Filename, EditorConfig, license-header, dependency-license, and commit-message checks passed.
  • The normal commit hook fails REPL-help lint on 121 pre-existing errors in 57 files, plus 16 warnings. Before/after validation shows identical rule IDs, messages, severities, and counts; only one diagnostic end-line position shifts with the EOF padding. No new diagnostics were introduced. The maintainer approved skipping only REPL-help lint for this EOF-only commit; the remaining commit and push hooks remain enabled.

Git's generic whitespace check reports added blank lines at EOF; those lines are the intentional formatting change in this PR.

Checklist

AI Assistance

  • Yes
  • No

How AI assistance was used:

  • Code generation (the temporary normalization and verification scripts)
  • Test/benchmark generation
  • Documentation (including this description)
  • Research and understanding

Disclosure

Codex prepared the EOF-only normalization and validation scripts, checked the resulting diff, and drafted this description under maintainer direction.


---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: skipped
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Planeshifter
Planeshifter marked this pull request as ready for review November 1, 2026 04:14
@Planeshifter
Planeshifter requested a review from a team November 1, 2026 04:14
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Nov 1, 2026
@kgryte

kgryte commented Nov 3, 2026

Copy link
Copy Markdown
Member

As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte changed the title docs: normalize trailing newlines in REPL help docs: normalize trailing newlines in REPL help texts Nov 3, 2026
@kgryte
kgryte merged commit 78ad2fa into develop Nov 3, 2026
30 of 34 checks passed
@kgryte
kgryte deleted the philipp/repl-help-eof branch November 3, 2026 23:27
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants