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

Annotation and docstring edits #127

Merged

Conversation

logicalzero
Copy link
Contributor

This should make no functional change; it adds type annotation and changes docstrings to use the standard Sphinx tags. The first step towards generating full docs.

@codecov-commenter
Copy link

codecov-commenter commented Nov 2, 2023

Codecov Report

Merging #127 (c4e5d6a) into development (64f9e07) will increase coverage by 0.32%.
The diff coverage is 89.61%.

@@               Coverage Diff               @@
##           development     #127      +/-   ##
===============================================
+ Coverage        80.62%   80.95%   +0.32%     
===============================================
  Files                7        7              
  Lines             1404     1402       -2     
===============================================
+ Hits              1132     1135       +3     
+ Misses             272      267       -5     
Files Coverage Δ
ebmlite/decoding.py 91.58% <100.00%> (+0.07%) ⬆️
ebmlite/encoding.py 95.10% <100.00%> (+0.03%) ⬆️
ebmlite/xml_codecs.py 73.72% <100.00%> (+0.68%) ⬆️
ebmlite/util.py 84.54% <90.90%> (ø)
ebmlite/core.py 78.72% <95.00%> (+0.12%) ⬆️
ebmlite/threaded_file.py 67.46% <63.33%> (+1.03%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@StokesMIDE StokesMIDE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a bit like cheating to approve myself, but these aren't functional changes.

@StokesMIDE StokesMIDE merged commit 45257fa into MideTechnology:development Nov 2, 2023
17 checks passed
@logicalzero logicalzero deleted the feature/docs_and_annotation branch November 7, 2023 03:31
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.

3 participants