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

Fix warnings in doc comments #196

Merged
merged 1 commit into from
Nov 13, 2021
Merged

Conversation

AntonHermann
Copy link
Contributor

Add automatic link markup to urls

Escape square brackets comments containing "[INFO]", "[WARNING]", "[ERROR]"

src/opts.rs Outdated Show resolved Hide resolved
Escape square brackets comments containing "[INFO]", "[WARNING]", "[ERROR]"

Suppress automatic link markup warning
@marcospb19 marcospb19 merged commit 9af1106 into ouch-org:master Nov 13, 2021
@AntonHermann
Copy link
Contributor Author

Regarding the URL markup not getting correctly parsed by clap, which is why we don't use rustdocs automatic link markup on user-facing doc comments (those that are used by clap to generate CLI help texts):

The clap issue I mentioned earlier was closed because there already is clap-rs/clap#2389 addressing a superset of this automatic link markup (i.e. parsing markdown/markup in general). If this is fixed someday, we could add the markup in src/opts.rs again (this has suuper low importance :D

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

Successfully merging this pull request may close these issues.

3 participants