Address Issue #74 - [DOC] add typings to functions#81
Merged
Conversation
Closed
Contributor
ferdia-sopermaccafraidh-lrn
left a comment
ferdia-sopermaccafraidh-lrn
left a comment
There was a problem hiding this comment.
👏 praise: Nice work! 🚀 Be great to finally have full typing!
👏 praise: Great and clear PR description as well! Really helped with context for reviewing!
🎯 suggestion (non-blocking): maybe if there's an appetite for this we can add mypy --strict to the pipeline to ensure we maintain our current typing after all this effort! This could maybe be a follow up PR if the mainters are happy?
shtrom
reviewed
Aug 19, 2024
Contributor
shtrom
left a comment
shtrom
left a comment
There was a problem hiding this comment.
Looking good! Couple of notes on the release process and Codacy warnings.
michael-linnane-lrn
force-pushed
the
ml-add-typings
branch
from
cb6a114 to
e6d3812
Compare
michael-linnane-lrn
changed the title
michael-linnane-lrn
requested review from
ferdia-sopermaccafraidh-lrn and
shtrom
michael-linnane-lrn
force-pushed
the
ml-add-typings
branch
from
1ff90b7 to
aed11d9
Compare
michael-linnane-lrn
force-pushed
the
ml-add-typings
branch
from
aed11d9 to
6cfe64a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem Statement
Open Issues this addresses: https://github.com/Learnosity/learnosity-sdk-python/issues/74
The functions used in this package do not have any type hints included. This PR addresses that.
PR Actions
closes #74
What was done
How was this change tested
mypy --strict learnosity_sdkto verify all type hints and issuesNotes and TODOs
make distcompleted successfully