Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Minor docs improvements #1774

Merged
merged 1 commit into from
Feb 4, 2021
Merged

Minor docs improvements #1774

merged 1 commit into from
Feb 4, 2021

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Feb 4, 2021

This was primarily motivated by noticing https://www.chisel-lang.org/chisel3/docs/explanations/blackboxes.html#blackboxes-with-verilog-in-a-resource-file currently has messed up formatting. I fixed some other things in the process and updated the docs for Bundle literals which are woefully out-of-date.

  • Fix some botched formatting (replace ```mdoc scala with ```scala mdoc)
  • Replace some unnecessary uses of triple backticks with single
    backticks
  • Move appendix docs from wiki-deprecated/ to appendix/
    • This will require an update on the website as well
  • Update Bundle literal docs

Contributor Checklist

  • [NA] 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?
  • [NA] Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • documentation

API Impact

No impact

Backend Code Generation Impact

No impact

Desired Merge Strategy

  • Squash

Release Notes

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?

* Fix some botched formatting (replace ```mdoc scala with ```scala mdoc)
* Replace some unnecessary uses of triple backticks with single
  backticks
* Move appendix docs from wiki-deprecated/ to appendix/
  * This will require an update on the website as well
* Update Bundle literal docs
@jackkoenig jackkoenig added this to the 3.4.x milestone Feb 4, 2021
@jackkoenig jackkoenig requested a review from azidar February 4, 2021 07:30
Copy link
Contributor

@mwachs5 mwachs5 left a comment

Choose a reason for hiding this comment

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

great!

Copy link
Contributor

@chick chick left a comment

Choose a reason for hiding this comment

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

lgtm

@jackkoenig jackkoenig merged commit 8fa4607 into master Feb 4, 2021
mergify bot pushed a commit that referenced this pull request Feb 4, 2021
* Fix some botched formatting (replace ```mdoc scala with ```scala mdoc)
* Replace some unnecessary uses of triple backticks with single
  backticks
* Move appendix docs from wiki-deprecated/ to appendix/
  * This will require an update on the website as well
* Update Bundle literal docs

(cherry picked from commit 8fa4607)
@mergify mergify bot added the Backported This PR has been backported label Feb 4, 2021
mergify bot added a commit that referenced this pull request Feb 4, 2021
* Fix some botched formatting (replace ```mdoc scala with ```scala mdoc)
* Replace some unnecessary uses of triple backticks with single
  backticks
* Move appendix docs from wiki-deprecated/ to appendix/
  * This will require an update on the website as well
* Update Bundle literal docs

(cherry picked from commit 8fa4607)

Co-authored-by: Jack Koenig <koenig@sifive.com>
@jackkoenig jackkoenig deleted the improve-docs branch February 5, 2021 03:54
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Backported This PR has been backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants