Polish up Quickstart guide #2042
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #2042 +/- ##
=======================================
Coverage 59.87% 59.87%
=======================================
Files 70 70
Lines 8157 8157
=======================================
Hits 4884 4884
Misses 3273 3273 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
DhruvSondhi
suggested changes
Jun 3, 2022
|
*beep* *bop* Hi, human. The Click here to see your results. |
2538613 to
667bbe9
Compare
|
I made all the sugested changes, plus other changes @andrewfullard |
atharva-2001
approved these changes
Jun 7, 2022
Rodot-
approved these changes
Jun 8, 2022
9 tasks
andrewfullard
approved these changes
Jun 13, 2022
epassaro
added a commit
to epassaro/tardis
that referenced
this pull request
Jun 14, 2022
* Polish up Quickstart guide (tardis-sn#2042) * Polish up Quickstart guide * Remove backticks * Try to fix traitlets FutureWarning * Change loglevel * Minor changes * Add plt.show() * Hide duplicated stderr messages * Add read more section * Minor changes * Final changes * Print config file * Use export_convergence_plot param * Add quickstart line in installation section * Minor changes * Disable profiling page build on pull requests (tardis-sn#2048) * Change developer installation command (tardis-sn#2053) * Define inputs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Type: 📝
documentationCurrently, the Quickstart guide has unnecessary long descriptions and long outputs. This is basically the same Quickstart guide but clearer and more concise.
📌 Resources
Old version: https://tardis-sn.github.io/tardis/quickstart.html
New version: https://tardis-sn.github.io/tardis/pull/2042/quickstart.html
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docslabel