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

Enable Rustfmt's wrap_comments option? #176

Open
gendx opened this issue Oct 5, 2020 · 3 comments
Open

Enable Rustfmt's wrap_comments option? #176

gendx opened this issue Oct 5, 2020 · 3 comments
Assignees
Labels
enhancement New feature or request tracking List of things to do

Comments

@gendx
Copy link
Collaborator

gendx commented Oct 5, 2020

As pointed out in #165 (comment), we currently allow comments that exceed the maximum line length normally allowed by Rustfmt.

We could enable the wrap_comments option in rustfmt.toml to make sure the comments don't exceed this maximum length, and are wrapped properly. This however requires a few things.

@gendx gendx closed this as completed Oct 5, 2020
@gendx gendx changed the title Enable Rustfmt Enable Rustfmt's wrap_comment option Oct 5, 2020
@gendx gendx changed the title Enable Rustfmt's wrap_comment option Enable Rustfmt's wrap_comments option Oct 5, 2020
@gendx gendx reopened this Oct 5, 2020
@gendx gendx changed the title Enable Rustfmt's wrap_comments option Enable Rustfmt's wrap_comments option? Oct 5, 2020
@gendx gendx added enhancement New feature or request tracking List of things to do labels Oct 5, 2020
@kaczmarczyck
Copy link
Collaborator

As indicated, I expected this to automatically checked. No strong opinion however, where are ASCII art examples that would need refactoring?

@gendx
Copy link
Collaborator Author

gendx commented Oct 12, 2020

As indicated, I expected this to automatically checked. No strong opinion however, where are ASCII art examples that would need refactoring?

It'd be easier to have an exhaustive list while reviewing code, but for a start src/ctap/ctap1.rs has some tables (not sure if it should be best described as "ASCII art" or "markdown").

@kaczmarczyck
Copy link
Collaborator

Just wanted to know if you have an intuition about how much we have to change. But it seems like our code would be nicer with correct length comments? But I'd say it's low priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request tracking List of things to do
Projects
None yet
Development

No branches or pull requests

2 participants