Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
about-code committed Aug 22, 2023
1 parent f03387a commit 533cca4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/ambiguities.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ By counting `perSectionDepth: 1` the algorithm assesses a new distribution and r
>
> a good choice for many situations.
>
> The default algorithm for priortizing definitions is `"by": "glossary-filename"`. It does not sort, contextually, but assumes priority of definitions from the alphanumeric order of glossary file names. This is a quite arbitrary decision and less helpful when it comes to ambiguities but is easier to reason about for new users.
> The default algorithm for priortizing definitions is `"by": "glossary-filename"`. It assumes definition priority solely from the alphanumeric order of glossary file names hosting definition. This strategy won't adapt to the writer's contextual use of terminology but therefore is also easier to reason about. For example, it is not expected to update link order in sections which haven't been changed, which is expected, though, when sorting by `glossary-ref-count`.
> **Supplementary Notes**
>
Expand Down
2 changes: 1 addition & 1 deletion md/doc/ambiguities.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ By counting `perSectionDepth: 1` the algorithm assesses a new distribution and r
>
> a good choice for many situations.
>
> The default algorithm for priortizing definitions is `"by": "glossary-filename"`. It does not sort, contextually, but assumes priority of definitions from the alphanumeric order of glossary file names. This is a quite arbitrary decision and less helpful when it comes to ambiguities but is easier to reason about for new users.
> The default algorithm for priortizing definitions is `"by": "glossary-filename"`. It assumes definition priority solely from the alphanumeric order of glossary file names hosting definition. This strategy won't adapt to the writer's contextual use of terminology but therefore is also easier to reason about. For example, it is not expected to update link order in sections which haven't been changed, which is expected, though, when sorting by `glossary-ref-count`.
> **Supplementary Notes**
> - Keep in mind that sorting by glossary ref. count means linkification is expected to produce different results between subsequent runs of glossarify-md depending on how your use of glossary terms changed between those runs.
Expand Down

0 comments on commit 533cca4

Please sign in to comment.