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

Update GenericSeries docstrings #712

Merged
merged 15 commits into from
Mar 16, 2022
Merged

Conversation

vhirtham
Copy link
Collaborator

@vhirtham vhirtham commented Mar 1, 2022

Changes

Update docstrings of GenericSeries constraint variables to help understand what their purpose is.

@vhirtham vhirtham added documentation Improvements or additions to documentation no-changelog-entry-needed labels Mar 1, 2022
@vhirtham vhirtham changed the title Gs var doc Update GenericSeries docstrings Mar 1, 2022
@github-actions
Copy link

github-actions bot commented Mar 1, 2022

Unit Test Results

       1 files  ±0         1 suites  ±0   4m 4s ⏱️ -8s
2 158 tests ±0  2 158 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 34e8e57. ± Comparison against base commit 0ba03fc.

♻️ This comment has been updated with latest results.

Copy link
Member

@CagtayFabry CagtayFabry left a comment

Choose a reason for hiding this comment

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

Thank you @vhirtham 👍
This is very helpful :)

I have added some suggestions, please take a look.

weldx/core.py Outdated Show resolved Hide resolved
weldx/core.py Outdated Show resolved Hide resolved
weldx/core.py Outdated Show resolved Hide resolved
weldx/core.py Outdated Show resolved Hide resolved
weldx/core.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Mar 4, 2022

Codecov Report

Merging #712 (34e8e57) into master (0ba03fc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #712   +/-   ##
=======================================
  Coverage   95.88%   95.88%           
=======================================
  Files          92       92           
  Lines        6496     6496           
=======================================
  Hits         6229     6229           
  Misses        267      267           
Impacted Files Coverage Δ
weldx/core.py 93.69% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0ba03fc...34e8e57. Read the comment docs.

vhirtham and others added 3 commits March 4, 2022 12:06
Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>
Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>
weldx/core.py Outdated Show resolved Hide resolved
vhirtham and others added 2 commits March 16, 2022 09:30
Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>
weldx/core.py Outdated Show resolved Hide resolved
weldx/core.py Outdated Show resolved Hide resolved
vhirtham and others added 2 commits March 16, 2022 09:34
Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>
weldx/core.py Outdated Show resolved Hide resolved
vhirtham and others added 3 commits March 16, 2022 09:37
Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>
@vhirtham vhirtham merged commit 846d182 into BAMWelDX:master Mar 16, 2022
@vhirtham vhirtham deleted the gs_var_doc branch March 16, 2022 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no-changelog-entry-needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants