Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markup remains in the help text #5937

Open
mslinn opened this issue Dec 17, 2024 · 1 comment
Open

Markup remains in the help text #5937

mslinn opened this issue Dec 17, 2024 · 1 comment
Labels
bug docs help-wanted The core team would like assistance in implementing this feature.

Comments

@mslinn
Copy link

mslinn commented Dec 17, 2024

Help text for git-lfs can be generated by simply typing git-lfs at a command prompt. Some of the resulting help text appears to have formatting left in it. For example, notice the dots and + characters in this exerpt:

Examples
--------

To get started with Git LFS, the following commands can be used.

. Setup Git LFS on your system. You only have to do this once per user
account:
+

git lfs install

. Choose the type of files you want to track, for examples all ISO
images, with git lfs track:
+

git lfs track "*.iso"

. The above stores this information in gitattributes(5) files, so that
file needs to be added to the repository:
+

git add .gitattributes

. Commit, push and work with the files normally:
+
@chrisd8088
Copy link
Member

chrisd8088 commented Dec 20, 2024 •
edited
Loading

Hey, thanks for the report! This looks like something we should be able to improve, and I suspect there are some other formatting anomalies in our manual pages as well.

The code which converts our AsciiDoc manual page source files to text is in the docs/man/mangen.go file, if anyone wants to take a look and try to craft a PR to address this issue.

In the meantime, I'll put this into our backlog as an improvement we'd like to make.

@chrisd8088 chrisd8088 added enhancement help-wanted The core team would like assistance in implementing this feature. docs labels Dec 20, 2024
@chrisd8088 chrisd8088 moved this to Enhancements in Backlog Dec 20, 2024
@chrisd8088 chrisd8088 moved this from Enhancements to Bugs in Backlog Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug docs help-wanted The core team would like assistance in implementing this feature.
Projects
Backlog
Status: Bugs
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mslinn @chrisd8088