Generated output (documentation, shell completion scripts, etc.) sometimes contain suboptimal whitespace

[rgoldberg]

Generated output (documentation, shell completion scripts, etc.) sometimes contain suboptimal whitespace

ArgumentParser version: main
Swift version:

swift-driver version: 1.120.5 Apple Swift version 6.1.2 (swiftlang-6.1.2.1.2 clang-1700.0.13.5)
Target: arm64-apple-macosx15.0

Checklist

• If possible, I've reproduced the issue using the main branch of this package
• I've searched for existing GitHub issues

Steps to Reproduce

Search test comparison files in the various Snapshots folders to find trailing spaces, or multiple or no newlines at the end of the file.

Once fixed, the new .editorconfigs in the Snapshot folders can be removed.

Expected behavior

No trailing spaces. One single newline at the end of every file.

Actual behavior

Sometimes: trailing spaces, multiple newlines at the end of a file, or no newlines at the end of a file.

@rauhul

[Chamepp]

Hello dear @rgoldberg, hope you are doing well. I believe that I have already addressed your issue in my PR. I have managed to trim any unnecessary trailing newline and solve this by using result = result.trimmingCharacters(in: .newlines) in my section generation.

[rgoldberg]

@Chamepp Thanks. Besides fixing generated Markdown, generated shell completion scripts must also be updated (or maybe just the testing thereof must be updated). Other output might also need to be updated.

Unfortunately, I cannot move PRs forward as I'm not a team member.

You might want to either rebase your PR on main or merge main into your PR, then request new reviews to move it through the merge process.

Once merged, I can check if anything besides completion scripts must be updated. If nothing else, then I can look into the completion script snapshots to finish fixing the other part of this issue.

[Chamepp]

Sure. I will keep you updated on this. I will solve the merge conflict again soon. Sorry for the delay, thank you for your patience 🙏