fix: types and documentation improvements #47
Merged
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.
Description
The main addition of this PR is a small set of improvments/fixes on types and code documentation (d811833), with the goal of making the docstrings and the types more accurate, remove unecessary ones and prepare for future API changes.
Then, I work on a few minor fixes, namely the PR template, which got out-of-date, and the python version.
Besides this, I made some work on standardazing this repository configs with other repositories we have at Linkup, which concretely means:
Since they are a lot of small changes in this PR, it might be easier to review it commit by commit.
Checklist
make install-dev
andmake test
README.md
if my changes affected itlinkup/_version.py
andpyproject.toml
if I plan on creating a new release