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

Add widgets documentation to tardis docs #1280

Merged
merged 11 commits into from
Sep 29, 2020

Conversation

jaladh-singhal
Copy link
Member

@jaladh-singhal jaladh-singhal commented Aug 19, 2020

It adds documentation of widgets to tardis docs by creating a directory tardis_widgets having:

  • using_widgets.rst - For description about how to use widgets and their features
  • generating_widgets.ipynb - Demo notebook to generate widgets

Note: This PR is branched on PR#1264, so should only be merged after #1264 gets merged

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

Review Jupyter notebook visual diffs & provide feedback on notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Aug 21, 2020

Codecov Report

Merging #1280 into master will decrease coverage by 0.17%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1280      +/-   ##
==========================================
- Coverage   81.75%   81.57%   -0.18%     
==========================================
  Files          44       46       +2     
  Lines        3699     3799     +100     
==========================================
+ Hits         3024     3099      +75     
- Misses        675      700      +25     
Impacted Files Coverage Δ
tardis/plasma/properties/ion_population.py
tardis/io/atom_data/atom_web_download.py
tardis/montecarlo/formal_integral.py
tardis/model/density.py
tardis/model/base.py
tardis/io/config_internal.py
tardis/io/parsers/stella.py
tardis/widgets/util.py
tardis/io/atom_data/base.py
tardis/io/util.py
... and 80 more

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 cc6fb1f...623f041. Read the comment docs.

@jaladh-singhal jaladh-singhal force-pushed the widgets/tardis-widgets-doc branch from 0d20076 to ee149f5 Compare August 25, 2020 19:09
Copy link
Member

@jamesgillanders jamesgillanders left a comment

Choose a reason for hiding this comment

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

great work @jaladh-singhal! Very well documented. Happy for this to be merged, pending review of my comments

@jaladh-singhal jaladh-singhal force-pushed the widgets/tardis-widgets-doc branch from 0f4c96c to 44f0b0f Compare September 22, 2020 18:57
@jaladh-singhal jaladh-singhal marked this pull request as ready for review September 22, 2020 18:59
Copy link
Contributor

@MarkMageeAstro MarkMageeAstro left a comment

Choose a reason for hiding this comment

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

One minor comment regarding grammar, but otherwise looks good.

Copy link
Contributor

@MarkMageeAstro MarkMageeAstro left a comment

Choose a reason for hiding this comment

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

Looks all good to me.

@marxwillia marxwillia merged commit f9c1dd7 into tardis-sn:master Sep 29, 2020
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
…widgets-doc

Add widgets documentation to tardis docs
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.

6 participants