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

Add custom mdoc modifier for emitted Verilog #1666

Merged
merged 1 commit into from
Nov 11, 2020
Merged

Add custom mdoc modifier for emitted Verilog #1666

merged 1 commit into from
Nov 11, 2020

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Nov 11, 2020

This adds a custom mdoc modifier for wrapping emitted Verilog examples in syntax highlightable markdown code blocks.

Example Before

Screen Shot 2020-11-11 at 11 18 02 AM

Example After

Screen Shot 2020-11-11 at 11 18 15 AM

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • 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

  • documentation
  • code cleanup
  • new feature/API

API Impact

Adds documentation API to mdoc: mdoc:verilog modifier

Backend Code Generation Impact

No impact

Desired Merge Strategy

squash

Release Notes

Add Verilog syntax highlighting to documentation examples

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (3.2.x, 3.3.x, 3.4.0, 3.5.0) ?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you mark as Please Merge?

@jackkoenig jackkoenig added this to the 3.4.x milestone Nov 11, 2020
@jackkoenig jackkoenig requested a review from a team as a code owner November 11, 2020 20:38
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

Awesome!

@mwachs5
Copy link
Contributor

mwachs5 commented Nov 11, 2020

❤️

@seldridge seldridge added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Nov 11, 2020
@mergify mergify bot merged commit e6192ea into master Nov 11, 2020
mergify bot pushed a commit that referenced this pull request Nov 11, 2020
@mergify mergify bot added the Backported This PR has been backported label Nov 11, 2020
mergify bot added a commit that referenced this pull request Nov 11, 2020
(cherry picked from commit e6192ea)

Co-authored-by: Jack Koenig <koenig@sifive.com>
@jackkoenig jackkoenig deleted the enhance-mdoc branch December 1, 2020 19:08
jackkoenig added a commit that referenced this pull request Feb 28, 2023
Use WrappedExpression instead of MemoizedHash. The benefit of memoizing
the hash pales in comparison to the cost of hashing deeply nested Types
in the AST.

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@ibm.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.

3 participants