Skip to content

rustfmt: format doc comments #2866

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

Merged
merged 1 commit into from
Jan 18, 2022

Conversation

dianpopa
Copy link
Contributor

@dianpopa dianpopa commented Jan 18, 2022

Reason for This PR

Fixes #1321.

Description of Changes

[Author TODO: add description of changes.]

  • This functionality can be added in rust-vmm.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The issue which led to this PR has a clear conclusion.
  • This PR follows the solution outlined in the related issue.
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any newly added unsafe code is properly documented.
  • Any API changes follow the Runbook for Firecracker API changes.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

@dianpopa dianpopa self-assigned this Jan 18, 2022
Copy link
Contributor

@georgepisaltu georgepisaltu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@alindima
Copy link
Contributor

I see that this is still considered an unstable feature. Do we want to merge it as-is and later rollback if we see stability issues? @dianpopa

@dianpopa dianpopa merged commit 0965ccf into firecracker-microvm:main Jan 18, 2022
@dianpopa
Copy link
Contributor Author

I see that this is still considered an unstable feature. Do we want to merge it as-is and later rollback if we see stability issues? @dianpopa

Unstable features are not merged in stable branches (which we are using). Where did you see that this is still unstable?

@alindima
Copy link
Contributor

I see that this is still considered an unstable feature. Do we want to merge it as-is and later rollback if we see stability issues? @dianpopa

Unstable features are not merged in stable branches (which we are using). Where did you see that this is still unstable?

I was referring to the rustfmt docs: https://rust-lang.github.io/rustfmt/?version=v1.4.38&search=#format_code_in_doc_comments

But it seems that the docs are outdated

@dianpopa dianpopa deleted the little_fixes branch July 13, 2022 09:15
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.

Documentation code does not get rustfmt'd by default
4 participants