Skip to content

Conversation

@hwhsu1231
Copy link
Contributor

@hwhsu1231 hwhsu1231 commented Jan 3, 2026

Adjust the formatting of the options and examples sections in the uudoc output to use Markdown headers:

  • Change <h2>Options</h2> to ## Options
  • Change Examples to ## Examples
  • Add regression test to prevent reverting to HTML headers

Close: #10003

@sylvestre
Copy link
Contributor

I don't know if we have unit tests for this but if we do, could you please add a test to make sure we don't regress? Thanks

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

GNU testsuite comparison:

Skip an intermittent issue tests/timeout/timeout (fails in this run but passes in the 'main' branch)

@hwhsu1231
Copy link
Contributor Author

I don't know if we have unit tests for this but if we do, could you please add a test to make sure we don't regress? Thanks

@sylvestre Done.

@github-actions
Copy link

github-actions bot commented Jan 3, 2026

GNU testsuite comparison:

GNU test failed: tests/tty/tty-eof. tests/tty/tty-eof is passing on 'main'. Maybe you have to rebase?
Skip an intermittent issue tests/timeout/timeout (fails in this run but passes in the 'main' branch)

@sylvestre
Copy link
Contributor

many jobs are failing

@hwhsu1231 hwhsu1231 force-pushed the adjust-uudoc-h2-format branch 2 times, most recently from d7720b3 to 7432616 Compare January 3, 2026 13:12
@hwhsu1231
Copy link
Contributor Author

@sylvestre I just squashed the commits into a single one and force-pushed. All the CI checks should pass now.

Adjust the formatting of the options and examples sections in the
uudoc output to use Markdown headers:

- Change `<h2>Options</h2>` to `## Options`
- Change `Examples` to `## Examples`
- Add regression test to prevent reverting to HTML headers
@hwhsu1231 hwhsu1231 force-pushed the adjust-uudoc-h2-format branch from 7432616 to 3dfeaa3 Compare January 3, 2026 13:20
@hwhsu1231
Copy link
Contributor Author

@sylvestre Please help me approve workflows.

@sylvestre sylvestre merged commit 730b0a6 into uutils:main Jan 3, 2026
131 checks passed
@hwhsu1231 hwhsu1231 deleted the adjust-uudoc-h2-format branch January 4, 2026 15:16
sgmarz pushed a commit to sgmarz/coreutils that referenced this pull request Jan 7, 2026
…ls#10004)

Adjust the formatting of the options and examples sections in the
uudoc output to use Markdown headers:

- Change `<h2>Options</h2>` to `## Options`
- Change `Examples` to `## Examples`
- Add regression test to prevent reverting to HTML headers
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.

uudoc: Missing H2 header for "Examples" section

2 participants