-
Notifications
You must be signed in to change notification settings - Fork 5
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
Feature/flat namespace #58
Conversation
Codecov Report
@@ Coverage Diff @@
## master #58 +/- ##
==========================================
- Coverage 97.23% 97.22% -0.01%
==========================================
Files 26 25 -1
Lines 1844 1840 -4
Branches 172 172
==========================================
- Hits 1793 1789 -4
Misses 39 39
Partials 12 12 Continue to review full report at Codecov.
|
I've added a documentation build for this branch to readthedocs. |
The changes to the actual I recommend finishing the documentation in a later pull request, possibly for each topic individually. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks very neat now, great!
I left some comments to improve the documentation even more :)
docs/source/api/usim.rst
Outdated
A :py:class:`~usim.Scope` that is also forcefully closed | ||
when a specific notification triggers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit confusion compared to the Scope
above. It might help to leave out the also. I think the description should make clear that it is about the specific notification.
docs/source/api/usim.rst
Outdated
These can be inspected for their current status, | ||
and various exceptions are unique to them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are the exceptions unique for the current status?
What do you think about making it into two sentences. It might help to state:
These can be inspected for their current status, | |
and various exceptions are unique to them. | |
Various exceptions are unique to tasks. |
Would you add another ticket for adapting the documentation? Thanks! |
Opened #60 to track manual documentation. |
Co-Authored-By: Eileen Kuehn <[email protected]>
Co-Authored-By: Max Fischer <[email protected]>
Added missing introduction sections and cleaned up the one mentioned. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the adaptations. Looks good now, I only found two minor things O:)
Co-Authored-By: Eileen Kuehn <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great now! 👍
This pull request flattens the usim namespace. Changes include:
usim.basics
intousim
,This pull request closes #54, closes #20 and addresses #36.