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.

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

Nitpick: doc for generated vec-like methods have extra spaces #34

Open
Artoria2e5 opened this issue May 3, 2021 · 1 comment
Open

Comments

@Artoria2e5
Copy link

The current doc-generation code looks like:
https://github.com/lumol-org/soa-derive/blob/d16585c/soa-derive-internal/src/vec.rs#L54-L56

As a result, it introduces extra spaces due to markdown translating newlines to spaces:

http://lumol.org/soa-derive/soa_derive_example/struct.ParticleVec.html#impl-2
Screen Shot 2021-05-03 at 12 09 41

With rust-lang/rust#78837 I think a bit of extra magic can be used here to generate the entire part inside of the square brackets.

@Luthaf
Copy link
Member

Luthaf commented May 3, 2021

I dit not know about this feature, it seems nice! I'm not sure if changing the doc to this new use of attributes can be done without bumping MSRV though.

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

No branches or pull requests

2 participants