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

[Doc Improvements I] Add more annotations types and docstrings #52

Merged
merged 23 commits into from
Apr 10, 2024

Conversation

CodyCBakerPhD
Copy link
Member

Also changed the name of the original class from TQDMPublisher -> TQDMProgressPublisher to be consistent with the new other subclasses - what do you think?

@CodyCBakerPhD CodyCBakerPhD self-assigned this Apr 8, 2024
@CodyCBakerPhD
Copy link
Member Author

I do seem to have broken the front-end display (backend server appears to be running fine) - perhaps I changed some object name in the messages sent to the client without changing what the client expects?

@garrettmflynn
Copy link
Collaborator

Fixed. There was some use of id when we now expect progress_bar_id everywhere except when forwarding through the HTTP server.

@garrettmflynn
Copy link
Collaborator

Do we want to continue maintaining the WS version of the parallel progress bars?

Copy link

codecov bot commented Apr 10, 2024

Codecov Report

Attention: Patch coverage is 43.75000% with 18 lines in your changes are missing coverage. Please review.

Project coverage is 50.00%. Comparing base (5e13565) to head (9240235).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
- Coverage   52.17%   50.00%   -2.18%     
==========================================
  Files           6        6              
  Lines          92      100       +8     
==========================================
+ Hits           48       50       +2     
- Misses         44       50       +6     
Flag Coverage Δ
unittests 50.00% <43.75%> (-2.18%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/tqdm_publisher/__init__.py 100.00% <100.00%> (ø)
...m_publisher/_demos/_demo_command_line_interface.py 0.00% <ø> (ø)
src/tqdm_publisher/_publisher.py 100.00% <100.00%> (ø)
src/tqdm_publisher/_subscriber.py 50.00% <50.00%> (-10.00%) ⬇️
src/tqdm_publisher/_handler.py 36.36% <22.22%> (-4.82%) ⬇️

@CodyCBakerPhD
Copy link
Member Author

Do we want to continue maintaining the WS version of the parallel progress bars?

It seems distinct enough from Flask that I'm not against having it - I was planning to add further docs to that in a follow-up though

(and there seems to be enough of a platform-specific difference in behavior between the two to be useful to highlight as well)

@CodyCBakerPhD
Copy link
Member Author

Thanks for fixing!

Frontend works again now

Probably enough changes here to merit review & merge

@CodyCBakerPhD CodyCBakerPhD enabled auto-merge (squash) April 10, 2024 18:00
Copy link
Collaborator

@garrettmflynn garrettmflynn left a comment

Choose a reason for hiding this comment

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

Looking good. Thanks for making these changes!

@CodyCBakerPhD CodyCBakerPhD merged commit 68e1159 into main Apr 10, 2024
13 of 14 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the doc_improvements branch April 10, 2024 18:57
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.

2 participants