Skip to content

Commit

Permalink
Fix docs typos (#2629)
Browse files Browse the repository at this point in the history
This change fixes:
  - Typos in the `build_doc.sh` references.
  - Incorrect rendering of python code blocks on Flare API page.
  • Loading branch information
apatole authored Jun 11, 2024
1 parent 8f7bfad commit c16f453
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ python3 -m pip install nvflare[dev]
To build the docs, please run.

```bash
./build_docs.sh --html
./build_doc.sh --html
```

Once built, you can view the docs in `docs/_build folder`. To clean the docs, please run

```bash
./build_docs.sh --clean
./build_doc.sh --clean
```

#### Signing your work
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,14 @@ To build the docs, please run.

.. code:: bash
./build_docs --html
./build_doc.sh --html
Once built, you can view the docs in ``docs/_build folder``. To clean
the docs, please run

.. code:: bash
./build_docs --clean
./build_doc.sh --clean
Signing your work
^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions docs/real_world_fl/flare_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Like with FLAdminAPI previously, :class:`AdminAPI<nvflare.fuel.hci.client.api.Ad

There is no more ``logout()``, instead, use ``close()`` to end the session. One common pattern of usage may be to have the code using the session
to execute commands inside a try block and then close
the session in a finally clause::
the session in a finally clause:

.. code-block:: python
Expand All @@ -64,7 +64,7 @@ the session in a finally clause::
Additional and Complex Commands
-------------------------------
With a ``job_id`` for example after submit_job in the code block above, here are some examples of other commands that
can be run::
can be run:

.. code-block:: python
Expand Down

0 comments on commit c16f453

Please sign in to comment.