Skip to content

Commit 6fcf80e

Browse files
authored
Minor fix to documentation (#399)
1 parent e5e7550 commit 6fcf80e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

doc/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ You can add content to the documentation in two ways:
125125
1. By adding or updating [google style python docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) in the micro-sam code.
126126
* [pdoc](https://pdoc.dev/docs/pdoc.html) will automatically find and include docstrings in the documentation.
127127
2. By adding or editing markdown files in the micro-sam `doc` directory.
128-
* If you add a new narkdown file to the documentation, you must tell [pdoc](https://pdoc.dev/docs/pdoc.html) that it exists by adding a line to the `micro_sam/__init__.py` module docstring (eg: `.. include:: ../doc/my_amazing_new_docs_page.md`). Otherwise it will not be included in the final documenation build!
128+
* If you add a new markdown file to the documentation, you must tell [pdoc](https://pdoc.dev/docs/pdoc.html) that it exists by adding a line to the `micro_sam/__init__.py` module docstring (eg: `.. include:: ../doc/my_amazing_new_docs_page.md`). Otherwise it will not be included in the final documentation build!
129129

130130
## Optional: Benchmark performance
131131

doc/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ We also provide installers for Linux and Windows:
9393
- [Mac](https://owncloud.gwdg.de/index.php/s/7YupGgACw9SHy2P)
9494
-->
9595

96-
**The installers are stil experimental and not fully tested.** Mac is not supported yet, but we are working on also providing an installer for it.
96+
**The installers are still experimental and not fully tested.** Mac is not supported yet, but we are working on also providing an installer for it.
9797

9898
If you encounter problems with them then please consider installing `micro_sam` via [mamba](#from-mamba) instead.
9999

0 commit comments

Comments
 (0)