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

Documentation for Features In-Progress #2105

Merged
merged 8 commits into from
Aug 3, 2022

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Jul 22, 2022

📝 Description

Type: 📝 documentation

Currently, the development roadmap section of the TARDIS documentation is highly outdated. In addition to updating it, this PR makes a place in the documentation for placing documentation for features not yet implemented into TARDIS, as this has been demonstrated to be necessary given all the new developments going on in the collaboration.

This is in accordance with discussions at TARDIS-con.

Note: I think I may be missing something about Hydrogen NLTE. Please let me know if this is the case, and if so what to put for it.

📌 Resources

See the new page: https://tardis-sn.github.io/tardis/pull/2105/contributing/in_progress/index.html

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

Docs built on GitHub.

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@codecov
Copy link

codecov bot commented Jul 22, 2022

Codecov Report

Merging #2105 (edea849) into master (a2ed8b5) will increase coverage by 3.19%.
The diff coverage is n/a.

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

@@            Coverage Diff             @@
##           master    #2105      +/-   ##
==========================================
+ Coverage   58.13%   61.33%   +3.19%     
==========================================
  Files          75       75              
  Lines        8602     8602              
==========================================
+ Hits         5001     5276     +275     
+ Misses       3601     3326     -275     
Impacted Files Coverage Δ
tardis/visualization/widgets/custom_abundance.py 59.53% <0.00%> (+42.96%) ⬆️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@isaacgsmith isaacgsmith requested a review from Rodot- July 29, 2022 19:24
@isaacgsmith isaacgsmith marked this pull request as ready for review July 29, 2022 19:25
docs/contributing/in_progress/index.rst Outdated Show resolved Hide resolved
docs/contributing/in_progress/index.rst Outdated Show resolved Hide resolved
docs/contributing/in_progress/index.rst Outdated Show resolved Hide resolved
@wkerzendorf wkerzendorf merged commit fb53e68 into tardis-sn:master Aug 3, 2022
@isaacgsmith isaacgsmith deleted the future_development_docs branch August 3, 2022 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants