Skip to content

Commit

Permalink
Correct cross-ref hint
Browse files Browse the repository at this point in the history
  • Loading branch information
lkubb committed Aug 20, 2024
1 parent 1e2f8d7 commit 013d2c9
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/topics/documenting/writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ It's possible to cross-reference specific entities, which can improve the docume
Link to a complete module.

:::{hint}
Works for all modules that are present in the virtual environment, which includes Salt core ones.
Works for all packages whose docs are registered in the `docs/conf.py`
`intersphinx_mapping`. This specifically includes Salt core by default.
:::

:::{tab} MyST
Expand All @@ -39,7 +40,8 @@ Works for all modules that are present in the virtual environment, which include
Link to a specific function in a module.

:::{hint}
Works for all modules that are present in the virtual environment, which includes Salt core ones.
Works for all packages whose docs are registered in the `docs/conf.py`
`intersphinx_mapping`. This specifically includes Salt core by default.
:::

:::{tab} MyST
Expand Down

0 comments on commit 013d2c9

Please sign in to comment.