8000 DOC Improve format in Documentation section of contributing.rst (#24467) · thomasjpfan/scikit-learn@dfddeb1 · GitHub
[go: up one dir, main page]

Skip to content

Commit dfddeb1

Browse files
authored
DOC Improve format in Documentation section of contributing.rst (scikit-learn#24467)
1 parent e182edd commit dfddeb1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/developers/contributing.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -671,25 +671,25 @@ Documentation
671671

672672
We are glad to accept any sort of documentation:
673673

674-
* function/method/class docstrings (also known as "API documentation") - these
675-
describe what the object does and details any parameters, attributes and
674+
* **function/method/class docstrings** (also known as "API documentation") -
675+
these describe what the object does and details any parameters, attributes and
676676
methods. Docstrings live alongside the code in
677-
`sklearn/ <https://github.com/scikit-learn/scikit-learn/tree/main/sklearn>`_
678-
* user guide - these provide more detailed information about the algorithms
677+
`sklearn/ <https://github.com/scikit-learn/scikit-learn/tree/main/sklearn>`_.
678+
* **user guide** - these provide more detailed information about the algorithms
679679
implemented in scikit-learn and generally live in the root
680680
`doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc>`_ directory
681681
and
682-
`doc/modules/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc/modules>`_
683-
* tutorials - these introduce various statistical learning and machine learning
682+
`doc/modules/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc/modules>`_.
683+
* **tutorials** - these introduce various statistical learning and machine learning
684684
concepts and are located in
685-
`doc/tutorial <https://github.com/scikit-learn/scikit-learn/tree/main/doc/tutorial>`_
686-
* examples - these provide full code examples that may demonstrate the use of
687-
scikit-learn modules, compare different algorithms or discuss their
685+
`doc/tutorial <https://github.com/scikit-learn/scikit-learn/tree/main/doc/tutorial>`_.
686+
* **examples** - these provide full code examples that may demonstrate the use
687+
of scikit-learn modules, compare different algorithms or discuss their
688688
interpretation etc. Examples live in
689689
`examples/ <https://github.com/scikit-learn/scikit-learn/tree/main/examples>`_
690-
* other reStructuredText documents (like this one) - provide various other
690+
* **other reStructuredText documents** (like this one) - provide various other
691691
useful information (e.g., our guide to contributing) and live in
692-
`doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc>`_
692+
`doc/ <https://github.com/scikit-learn/scikit-learn/tree/main/doc>`_.
693693

694694
You can edit the documentation using any text editor, and then generate the
695695
HTML output by following :ref:`building_documentation`. The resulting HTML files

0 commit comments

Comments
 (0)
0