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

reflow documentation comments + markdown files #39

Closed
drahnr opened this issue Jun 18, 2020 · 3 comments · Fixed by #121
Closed

reflow documentation comments + markdown files #39

drahnr opened this issue Jun 18, 2020 · 3 comments · Fixed by #121
Assignees
@drahnr @KuabeM
Labels
enhancement 🦚 New feature or request good first issue 🔰 Good for newcomers help wanted 🤝 Extra attention is needed
Milestone
v0.5.0

Comments

@drahnr
Copy link
Owner

drahnr commented Jun 18, 2020

Summary

Wrapping of doc comments is a nice addition to make the comments look nicer in code.

Probably requires a new set of parameters, i.e. line width (soft and hard limits) and how to deal with extra long link descriptions.
@drahnr drahnr added enhancement 🦚 New feature or request help wanted 🤝 Extra attention is needed labels Jun 18, 2020
@drahnr drahnr mentioned this issue Jun 18, 2020
Closed
@drahnr
Copy link
Owner Author

drahnr commented Jul 10, 2020

Textwrap already does something very similar https://crates.io/crates/textwrap

@drahnr drahnr added the good first issue 🔰 Good for newcomers label Jul 10, 2020
@KuabeM
Copy link
Collaborator

KuabeM commented Jul 10, 2020

I was just about to post my 'algorithm'... That's convenient!

@drahnr
Copy link
Owner Author

drahnr commented Jul 10, 2020 •
edited
Loading

Did not mean to interfere, mostly a pointer how we could approach it - the above is not markdown/cmark aware iiuc so there probably is still a chunk of algorithm work left to do :)

@KuabeM KuabeM mentioned this issue Jul 10, 2020
Closed
@drahnr drahnr added this to the v0.3.0 milestone Jul 14, 2020
@drahnr drahnr changed the title rewrap documentation comments + markdown files reflow documentation comments + markdown files Jul 16, 2020
@drahnr drahnr modified the milestones: v0.3.0, v0.4.0 Jul 16, 2020
@drahnr drahnr modified the milestones: v0.4.0, v0.5.0 Aug 17, 2020
@drahnr drahnr self-assigned this Aug 19, 2020
@drahnr drahnr mentioned this issue Sep 11, 2020
Closed
7 tasks
@KuabeM KuabeM mentioned this issue Oct 24, 2020
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@drahnr drahnr

@KuabeM KuabeM

Labels
enhancement 🦚 New feature or request good first issue 🔰 Good for newcomers help wanted 🤝 Extra attention is needed
Projects
None yet
Milestone
v0.5.0
2 participants
@drahnr @KuabeM