8000 Replace <code> with backticks in docs. Addresses #255 by thundergolfer · Pull Request #486 · bazel-contrib/rules_python · GitHub
[go: up one dir, main page]
Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 16, 2021
Merged

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

merged 2 commits into from
Jun 16, 2021

Conversation

thundergolfer
Copy link

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

@google-cla google-cla bot added the cla: yes label Jun 9, 2021
@thundergolfer thundergolfer requested review from hrfuller and removed request for andyscott June 9, 2021 07:55
@thundergolfer thundergolfer mentioned this pull request Jun 9, 2021
Closed
hrfuller
hrfuller approved these changes Jun 16, 2021
View reviewed changes
docs/whl.md
@@ -32,9 +32,9 @@ This rule defines `@foo//:pkg` as a `py_library` target.
| Name | Description | Type | Mandatory | Default |
| :-------------: | :-------------: | :-------------: | :-------------: | :-------------: |
| 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
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
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
Reviewers

@hrfuller hrfuller hrfuller approved these changes

@brandjon brandjon Awaiting requested review from brandjon

@lberki lberki Awaiting requested review from lberki

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Upgrade stardoc, switch to markdown syntax in args
2 participants
@thundergolfer @hrfuller
0