Skip to content

Commit bcd716b

Browse files
authored
[DOC] Fix various RST issues (#18789)
Fix various RST issues in files: - docs/contribute/ci.rst - docs/contribute/code_guide.rst
1 parent 4d4351d commit bcd716b

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/contribute/ci.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,11 @@ Dealing with Flakiness
113113
^^^^^^^^^^^^^^^^^^^^^^
114114

115115
If you notice a failure on your PR that seems unrelated to your change, you should
116-
search [recent GitHub issues related to flaky tests](https://github.com/apache/tvm/issues?q=is%3Aissue+%5BCI+Problem%5D+Flaky+>) and
117-
[file a new issue](https://github.com/apache/tvm/issues/new?assignees=&labels=&template=ci-problem.md&title=%5BCI+Problem%5D+>)
116+
search `recent GitHub issues related to flaky tests <https://github.com/apache/tvm/issues?q=is%3Aissue+%5BCI+Problem%5D+Flaky>`_ and
117+
`file a new issue <https://github.com/apache/tvm/issues/new?assignees=&labels=&template=ci-problem.md&title=%5BCI+Problem%5D>`_
118118
if you don't see any reports of the failure. If a certain test or class of tests affects
119-
several PRs or commits on `main` with flaky failures, the test should be disabled via
120-
[pytest's @xfail decorator](https://docs.pytest.org/en/6.2.x/skipping.html#xfail-mark-test-functions-as-expected-to-fail) with [`strict=False`](https://docs.pytest.org/en/6.2.x/skipping.html#strict-parameter) and the relevant issue linked in the
119+
several PRs or commits on ``main`` with flaky failures, the test should be disabled via
120+
`pytest's @xfail decorator <https://docs.pytest.org/en/6.2.x/skipping.html#xfail-mark-test-functions-as-expected-to-fail>`_ with `strict=False <https://docs.pytest.org/en/6.2.x/skipping.html#strict-parameter>`_ and the relevant issue linked in the
121121
disabling PR.
122122

123123
.. code-block:: python

docs/contribute/code_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Python Code Styles
9898

9999
The pylint check ``no-else-return`` is disabled to allow for this
100100
distinction. See further discussion `here
101-
<https://github.com/apache/tvm/pull/11327>`.
101+
<https://github.com/apache/tvm/pull/11327>`_.
102102

103103
.. code:: python
104104

0 commit comments

Comments
 (0)