Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation site #11

Merged
merged 26 commits into from
Mar 13, 2024
Merged

documentation site #11

merged 26 commits into from
Mar 13, 2024

Conversation

lukavdplas
Copy link
Contributor

Adds a documentation site based on MKDocs. At the moment, you need to clone and use mkdocs serve to host it locally, but I'll bring it online after merging. (close #2)

Because the documentation is largely generated from the code, I also improved the clarity there:

  • Substantial expansion docstrings. Every function that is documented in the API reference now has a docstring that lists arguments and what the function returns.
  • Docstrings use standardised formatting (google-style) for parameters and the returned value
  • Added type annotations to most API functions
  • Adds a unit test for each reader type. This was mainly to make sure my type annotations did not contain syntax errors. (close add unit tests #1)

Also:

  • updates some error messages that referenced "CorpusDefinition"
  • updated some argument names in csv-related functions that take a column name, to say column rather than field. This makes argument hints easier to understand, but I've kept class members as-is, so it does introduce some inconsistency.
  • removed some stray functions in readers.core that were just left over from I-analyzer.

Request for review: the documentation is fairly straightforward, so don't worry about checking every detail. I'd be happy if you can check if the above list of changes sounds good and glance through the documentation site.

@JeltevanBoheemen JeltevanBoheemen merged commit ee0d349 into develop Mar 13, 2024
8 checks passed
@JeltevanBoheemen JeltevanBoheemen deleted the feature/documentation branch March 13, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add documentation add unit tests
2 participants