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

validate word splits / hypenation #40

Closed
drahnr opened this issue Jun 18, 2020 · 2 comments
Closed

validate word splits / hypenation #40

drahnr opened this issue Jun 18, 2020 · 2 comments
Labels
enhancement 🦚 New feature or request good first issue 🔰 Good for newcomers help wanted 🤝 Extra attention is needed
Projects
Overview

Comments

@drahnr
Copy link
Owner

drahnr commented Jun 18, 2020 •
edited
Loading

Summary

Word splits are currently not validated, but each component of them. This should be a pass before sending it to the checkers.

Context
@drahnr drahnr added enhancement 🦚 New feature or request help wanted 🤝 Extra attention is needed labels Jun 18, 2020
@drahnr drahnr changed the title validate work splits validate word splits Jun 18, 2020
@drahnr drahnr added this to To Do in Overview Jul 8, 2020
@drahnr
Copy link
Owner Author

drahnr commented Jul 10, 2020

Consider using https://crates.io/crates/hyphenation

@drahnr drahnr added the good first issue 🔰 Good for newcomers label Jul 10, 2020
@drahnr drahnr changed the title validate word splits validate word splits / hypenation Aug 17, 2020
@drahnr
Copy link
Owner Author

drahnr commented Aug 17, 2020 •
edited
Loading

Hyphenation is very unlikely to yield any gain, commonly there is no hyphenation used in doc comments and even if so, commonmark would reflow them in the rendered htmls anyways and cause weird dashed words, so trailing - are rather a general issue to be fixed in doc-comments and not treated as a feature.
If we ever wanted to support hypenation-removal it would be part of #39 where the trailing words would need to be checked for ending with - (before applying quirks) and re-combining them, but that seems like a very very edge case thing.

Closing.

@drahnr drahnr closed this as completed Aug 20, 2020
Overview automation moved this from To Do to Done Aug 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement 🦚 New feature or request good first issue 🔰 Good for newcomers help wanted 🤝 Extra attention is needed
Projects
Overview
  
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@drahnr