Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an update to the documentation. Here's a list of the changes made:
Other details:
Right now, the package doesn't allow for setting/creating glossaries. Also there is no documentation for the structure expected for glossaries, nor am I sure why this is something that should be described, since any changes made to the glosario YAML file are made within the carpentries/glosario project and not carpentries/glosario-py. And finally, even though there is the text by default glosario provides access ... I'm not sure where else glosario-py would be reading a glossary from?
For these reasons maybe we can change the about section simply to read: glosario-py provides Python based access to the community-curated technical glossary hosted by The Carpentries.