Skip to content

Replace <code> with backticks in docs. Addresses #255#486

Merged
thundergolfer merged 2 commits intomasterfrom
jonathon--issue-255-jun2021
Jun 16, 2021
Merged

Replace <code> with backticks in docs. Addresses #255#486
thundergolfer merged 2 commits intomasterfrom
jonathon--issue-255-jun2021

Conversation

@thundergolfer
Copy link
Copy Markdown

Closes #255


PR Checklist

Please check if your PR fulfills the following requirements:

  • Does not include precompiled binaries, eg. .par files. See CONTRIBUTING.md for info
  • [N/A] Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature (please, look at the "Scope of the project" section in the README.md file)
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe

Does this PR introduce a breaking change?

  • Yes
  • No

| :-------------: | :-------------: | :-------------: | :-------------: | :-------------: |
| name | A unique name for this repository. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |
| extras | A subset of the "extras" available from this &lt;code&gt;.whl&lt;/code&gt; for which &lt;code&gt;requirements&lt;/code&gt; has the dependencies. | List of strings | optional | [] |
| extras | A subset of the "extras" available from this <code>.whl</code> for which <code>requirements</code> has the dependencies. | List of strings | optional | [] |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

IIUC this document is converted to HTML so these tags do something in the final document?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Yeah. Viewing these docs using Intellij's markdown preview the tags are used to show preformatting.

image

@thundergolfer thundergolfer merged commit 6202ed2 into master Jun 16, 2021
@thundergolfer thundergolfer deleted the jonathon--issue-255-jun2021 branch June 16, 2021 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Upgrade stardoc, switch to markdown syntax in args

2 participants