-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
Markdown is not converted to ROFF for man pages #5095
Comments
This is probably due to how Debian renders the manpage online if it works locally. Or are lists supposed to be done some other way within manpages? |
Sorry, I made a mistake and I can now see what the problem is. I think the issue should be relabelled as a
This issue is not exclusive to the test manpage either. > rg --vimgrep "^\*" man | awk '{print $1}' | cut -d : -f1 | sort | uniq
man/cp.1
man/du.1
man/mknod.1
man/mv.1
man/nl.1
man/pr.1
man/printf.1
man/test.1 Documentation |
clap_mangen
does not render bullet lists correctly
I have closed my PR for the time being as it's probably not an issue with clap_mangen. Someone should verify but the section that @sylvestre referred to that isn't being parsed correctly is completed by the help_section proc macro and our own parser for markdown. This should probably be fixed up instead of using my quick fix. > rg test.md
src/uu/test/src/test.rs
25:const ABOUT: &str = help_about!("test.md");
39:const AFTER_HELP: &str = help_section!("after help", "test.md"); Related Filesproc macro
|
Hm, I don't see the connection with I think the "problem" is that a string passed to So I agree with you and I wouldn't call it an issue with clap_mangen. And yes, I think we should fix it properly in our code instead of using a quick fix. |
Yeah @cakebaker, I agree. |
So I suppose the conclusion is that we write markdown, which we then convert to
That's definitely some interesting infrastructure to build :) Edit: I renamed the issue again, hope that describes it better. |
clap_mangen
does not render bullet lists correctly
is it still a good first issue @tertsdiepraam ? :) |
It's an interesting one for sure! You could go for a solution that isn't perfect but only handles itemized lists for instance to make it simpler. |
see
https://manpages.debian.org/unstable/rust-coreutils/rust-test.1.en.html
to reproduce, with
#5092
The text was updated successfully, but these errors were encountered: