Skip to content

Commit e635e80

Browse files
henryiiiCopilot
andauthored
Apply suggestions from code review
Co-authored-by: Copilot <[email protected]>
1 parent e80e7f0 commit e635e80

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/pages/guides/docs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -391,9 +391,9 @@ and highlighting search terms after a user clicks on a search result
391391

392392
For navigation plugins (documented
393393
[here](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/)),
394-
we request the side navigation to be expanded by default (`naviation.expand`)
394+
we request the side navigation to be expanded by default (`navigation.expand`)
395395
and that the URL autoupdate to the latest anchor as a user scrolls through the
396-
page (`naviation.tracking`). Finally, we request that the current user section
396+
page (`navigation.tracking`). Finally, we request that the current user section
397397
is always shown and highlight in the sidebar via `toc.follow`.
398398

399399
In the palette section (documented
@@ -700,7 +700,7 @@ contents to:
700700
```
701701
702702
Where the triple colon syntax is used to specify what documentation you would
703-
like built. In this case, we are asking to document the entire module `my_class`
703+
like built. In this case, we are asking to document the entire module `my_module`
704704
(and all classes and functions within it) which is located in `my_package`. You
705705
could instead ask for only a single component inside your module by being more
706706
specific, like `::: my_package.my_module.MyClass`.

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def make_cruft(session: nox.Session, backend: str, vcs: bool, docs: Docs) -> Pat
132132

133133
session.cd(tmp_dir)
134134
Path("input.yml").write_text(
135-
JOB_FILE.format(backend=backend, pkg=package_dir, vcs=vcs, docs=docs),
135+
JOB_FILE.format(backend=backend, pkg=package_dir, vcs=vcs, docs=docs.value),
136136
encoding="utf-8",
137137
)
138138
session.run(

0 commit comments

Comments
 (0)