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

Restructure Model Configuration Documentation #1721

Merged
merged 12 commits into from
Aug 4, 2021

Conversation

isaacgsmith
Copy link
Member

Description

This restructures the model configuration documentation. This is the first step in this process -- more will be done in the future.

I am sure there are many changes I need to make so any feedback will be appreciated. It is a bit of a complicated page to write.

Motivation and context

This page has needed serious restructuring after #1643.

How has this been tested?

  • Testing pipeline.
  • Docs built locally.

Examples

See https://smithis7.github.io/tardis/branch/config_reorganize_doc/io/configuration/components/models/index.html

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@isaacgsmith isaacgsmith requested a review from marxwillia July 15, 2021 02:11
@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jul 15, 2021

Codecov Report

Merging #1721 (8661aab) into master (d3f13ed) will not change coverage.
The diff coverage is n/a.

❗ Current head 8661aab differs from pull request most recent head 41ea3d3. Consider uploading reports for the commit 41ea3d3 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1721   +/-   ##
=======================================
  Coverage   61.87%   61.87%           
=======================================
  Files          63       63           
  Lines        5852     5852           
=======================================
  Hits         3621     3621           
  Misses       2231     2231           

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 d3f13ed...41ea3d3. Read the comment docs.

@isaacgsmith
Copy link
Member Author

@andrewfullard and @marxwillia can we hold off on merging this until next week -- I would like some more people to read through it and give me some feedback because I am sure there are things on this page that should be improved.

@andrewfullard andrewfullard marked this pull request as draft July 16, 2021 14:17
@isaacgsmith isaacgsmith mentioned this pull request Jul 16, 2021
10 tasks
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@isaacgsmith isaacgsmith force-pushed the config_reorganize_doc branch 3 times, most recently from 97cdd67 to 83862fb Compare July 18, 2021 23:49
@isaacgsmith isaacgsmith marked this pull request as ready for review July 19, 2021 16:31
@marxwillia marxwillia merged commit 8f175b3 into tardis-sn:master Aug 4, 2021
@isaacgsmith isaacgsmith deleted the config_reorganize_doc branch August 30, 2021 21:14
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* getting config schemas to link together properly

* adding to CSVY model docs

* saving small amount of work

* draft changes

* finishing csvy section

* finishing rough draft

* grammar and formatting

* small fixes

* making more examples and lifting descriptions

* finishing second draft

* very small changes

* fixing typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants