-
Notifications
You must be signed in to change notification settings - Fork 57
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
Leading sharp in generated readme's example code #38
Comments
This comment has been minimized.
This comment has been minimized.
Well, the sharp is comming from |
@Empty2k12 this line is not included in the rustdoc so I'm assuming it also shouldn't be in cargo readme |
@msrd0 I'm not sure if this library is using rustdoc internally, so you could fix the problem yourself be removing that line. I don't understand why it's there anyways. |
Well, it's there because you'd usually write an empty line between your imports and the actual code. And this library claims to read docstrings, so I believe this is an issue. Removing that line is obviously a workaround. |
This library is reading docstrings, but I cannot find any instance where it claims it's doing the same as cargodoc. I would even go as far as saying that a line consisting only of |
cargo-reame does not use cargodoc, it uses its own parser. I will take a look at it, as soon as I can |
In the example code here there is a leading sharp in the first line that shouldn't be there. In the generated rustdoc it's not present.
Wrong Behaviour
The sharp followed by an empty line is included. Screenshot from the generated README:
Expected Behaviour
The sharp, along with the rest of the line, should not be included. Screenshot from the rustdoc:
Setup
Issue happens on both ArchLinux and AlpineLinux, Rust/Cargo 1.38.0, Cargo-Readme 3.1.2
The text was updated successfully, but these errors were encountered: