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 formatting issue in chisel-type-vs-scala-type.md #2655

Merged
merged 2 commits into from
Aug 2, 2022
Merged

Conversation

mwachs5
Copy link
Contributor

@mwachs5 mwachs5 commented Aug 1, 2022

Without this, we get some weirdly formatted sections / unevaluated mdoc blocks

Screen Shot 2022-08-01 at 2 17 28 PM

Contributor Checklist

  • [N/A] Did you add Scaladoc to every public function/method?
  • [N/A] Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • bug fix
  • documentation

API Impact

No Impact

Backend Code Generation Impact

No Impact

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference.

Release Notes

Fix formatting of Chisel Type vs Scala Type Article Section

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (Bug fix: 3.4.x, [small] API extension: 3.5.x, API modification or big change: 3.6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@mwachs5 mwachs5 added this to the 3.5.x milestone Aug 1, 2022
@mwachs5 mwachs5 changed the title Update chisel-type-vs-scala-type.md Fix formatting issue in chisel-type-vs-scala-type.md Aug 1, 2022
@mwachs5
Copy link
Contributor Author

mwachs5 commented Aug 1, 2022

and, hilariously, I violated many of the "don't do this" things in the article in that one uncompiled example... hooray for mdoc

@mwachs5 mwachs5 added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Aug 2, 2022
@mergify mergify bot merged commit 0b2c211 into master Aug 2, 2022
@mergify mergify bot deleted the mwachs5-patch-1 branch August 2, 2022 15:44
mergify bot pushed a commit that referenced this pull request Aug 2, 2022
@mergify mergify bot added the Backported This PR has been backported label Aug 2, 2022
mergify bot added a commit that referenced this pull request Aug 2, 2022
(cherry picked from commit 0b2c211)

Co-authored-by: Megan Wachs <megan@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants