Thanks to visit codestin.com
Credit goes to github.com

Auto generate typehints into documentation #561

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.

Sign up for GitHub

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

Jump to bottom

Merged

amandarichardsonn merged 19 commits into CrayLabs:develop from amandarichardsonn:sphinx-tox

Apr 25, 2024

Contributor

amandarichardsonn commented Apr 22, 2024

This PR removes :type: and :rtype: driectives from function docstrings as well as implements the sphinx-autodoc-typehints extension.

amandarichardsonn added 4 commits

April 21, 2024 21:53


          pushing initial


          remove type and rtype

648fcb1


          final updates

4dfcd42


          test readthedocs error

21871ac

amandarichardsonn requested a review from AlyssaCote

April 22, 2024 16:41


          testing ignore warning

codecov bot commented Apr 22, 2024 •

edited

Loading

Codecov Report

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

Project coverage is 69.26%. Comparing base (05a1e0a) to head (ddac0ca).

❗ Current head ddac0ca differs from pull request most recent head 7e9a56a. Consider uploading reports for the commit 7e9a56a to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #561      +/-   ##
===========================================
- Coverage    69.62%   69.26%   -0.36%     
===========================================
  Files           66       66              
  Lines         4546     4571      +25     
===========================================
+ Hits          3165     3166       +1     
- Misses        1381     1405      +24

Files	Coverage Δ
smartsim/_core/control/controller.py	`72.22% <ø> (+5.83%)`	⬆️
smartsim/_core/control/job.py	`90.66% <ø> (-5.02%)`	⬇️
smartsim/_core/control/jobmanager.py	`83.11% <ø> (-5.85%)`	⬇️
smartsim/_core/control/manifest.py	`81.25% <ø> (+3.47%)`	⬆️
smartsim/_core/generation/generator.py	`61.60% <ø> (+0.80%)`	⬆️
smartsim/_core/generation/modelwriter.py	`98.59% <ø> (+71.83%)`	⬆️
smartsim/_core/launcher/colocated.py	`58.24% <ø> (+4.39%)`	⬆️
smartsim/_core/launcher/launcher.py	`100.00% <ø> (ø)`
smartsim/_core/launcher/local/local.py	`95.45% <ø> (ø)`
smartsim/_core/launcher/step/mpiStep.py	`88.88% <ø> (+54.16%)`	⬆️
... and 28 more

... and 6 files with indirect coverage changes

amandarichardsonn added 10 commits

April 22, 2024 10:35


          testing

a05f89f


          test

c5cf064


          testing

d9345b7


          test

f2ce57b


          testing

4e406a6


          testing

9aa9517


          test

2db181d


          testing

eea4fc0


          test

e9cd300


          pushing for readthedocs

ddac0ca

AlyssaCote approved these changes

View reviewed changes

Contributor

AlyssaCote left a comment •

edited

Loading

The docs look great! Thanks for taking care of this! Don't forget to update the changelog, but other than that, LGTM!

amandarichardsonn added 4 commits

April 25, 2024 09:10


          Merge branch 'develop' of https://github.com/CrayLabs/SmartSim into s…

…phinx-tox


          update changelog

175e467


          testing

d34d4f7


          revert

7e9a56a

amandarichardsonn merged commit f5f2385 into CrayLabs:develop

amandarichardsonn deleted the sphinx-tox branch

April 25, 2024 21:10

amandarichardsonn added area: docs area: python labels

amandarichardsonn mentioned this pull request

Automate release notes #568

Merged

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

a3fb28c

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

0d5af54

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

b615a16

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

796e37d

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

0facea8

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

ankona pushed a commit to ankona/SmartSim that referenced this pull request


          Auto generate typehints into documentation (CrayLabs#561)

ba0774a

This PR removes :type: and :rtype: driectives from function docstrings
as well as implements the sphinx-autodoc-typehints extension.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

al-rigazzi added non-user-facing ignore-for-release labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs area: python ignore-for-release non-user-facing