Make consistency edits to documentation #1158
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
arjunsavel
changed the title
arjunsavel
changed the title
arjunsavel
force-pushed
the
documentation-edits
branch
from
8846944 to
973b66e
Compare
|
@chvogl @afloers ready for review! I'm thinking that the other items we discussed (now listed under "To do" on this project board) are more related to content additions than just maintaining consistency, so I think they belong in another PR. Please let me know if I've missed anything! |
afloers
reviewed
Jun 1, 2020
There was a problem hiding this comment.
Very nice work! I built the docs locally and encountered no problems.
I agree that this PR should only remove typos / maintain the consistency of the documentation and not add new stuff.
Have you checked if all occurrences of words like 'hdf5' or 'yaml' have been replaced?
|
@afloers I've now checked for Astropy, HDF5, CMFGEN, GitHub, and YAML! |
|
@arjunsavel - sorry there is a merge conflict - we removed physical_quantities and replaced it with a notebook. |
…formatted custom composition page.
…onfiguration page.
…as in continuous integration page.
…uded in the physics overview.
arjunsavel
force-pushed
the
documentation-edits
branch
from
44d6d28 to
4f4f664
Compare
|
@wkerzendorf No worries! I've rebased onto master. |
Codecov Report
@@ Coverage Diff @@
## master #1158 +/- ##
=======================================
Coverage 77.13% 77.13%
=======================================
Files 89 89
Lines 5551 5551
=======================================
Hits 4282 4282
Misses 1269 1269 Continue to review full report at Codecov.
|
afloers
approved these changes
Jun 17, 2020
6 tasks
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* Make consistency edits for index and installation docs pages. * Remove spaces from and add comma to quickstart notebook. * Ensure YAML and CSVY are all caps throughout the Model page. * Add colon before list in ejecta model configuration page. * Make YAML spelling consistent in power law density page. * Make YAML spelling consistent in exponential density page. * Add hyphens, commas, and make consistent capitalization in custom density page. * Make consistent spaces inside units and add period to custom density notebook. * Add spaces, commas, and move parens in uniform composition page. * Ensure capitalization, add spaces, move parens, add periods to ASCII formatted custom composition page. * Add em dashes, add periods, remove periods, make parameters code in configuration page. * Add commas, capitalizations, periods, and code words to config validator page. * Add comma and period to read_configuration notebook. * Add periods, commas, bullet points, and capitalizations to atomic data description page. * Add em dash and periods to command line run page. * Add commas, capitalizations to tardis gui page. * Add period and comma to interacting with TARDIS page. * Make plural consistency on cmfgen page. * Added colon before list in physics index page. * Capitalize TARDIS, link external modules when necessary, add a few commas to plasma landing page. * Add hyphens, capitalize a word, and correct a typo in the Monte Carlo energy packets page. * Correct typos, add hyphens, move around commas in packet propagation page. * Correct typos, move commas around in line interaction page. * Correct typos, moved commas around in estimators page. * Correct typos, move commas around for virtual packets page. * Correct typos, move around commas for direct integration page. * Correct typos and add commas to random sampling page. * Correct typos in old monte carlo page. * Fix latex error in old montecarlo * Fix typos in LTE plasma plage * Finish up neburlar plasma, make edits to macroactom. * Correct typos, move commas, attempt latex fix for nlte page. * Capitalize TARDIS in helium_nlte page. * Add hyphen in code comparison page. * Correct spelling of BibTeX. * Correct spelling of AstroPy, adding a comma to developer workflow page. * Correct capitalizations, correct typos, shuffle commas in running tests page. * Correct a few more typos in running tests page. * Change GitHub spelling on issues page * Correct typos, commas, and capitalizations in git workflow page. * Change AstroPy spelling in release workflow page. * Add a period and shuffle commas in update refdata page. * Add periods, correct capitalizations, correct typos, and shuffle commas in continuous integration page. * Change AstroPy spelling, add period at end of developer faq page. * Format bulleted list better in atomic data description page. * Capitalize TARDIS; remove montecarlo primer from index, as it is included in the physics overview. * Capitalize Python in installation page. * Make final latex equation render correctly * Reword a few lines in installation page. * linking Anaconda in installation page * Add link to CMFGEN reference * Add period to montecarlo index * Linking physics is incomplete to TARDIS project board * did not correctly format links in .rst files * Had not merged correctly! * Missed a uncapitalized YAML * Removed a few double spaces * Bulleted list was not rendering correctly * Converting AstroPy to Astropy * Capitalize TARDIS in new doc notebook
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
I've gone through through the documentation and ensuring consistency throughout:
In addition, I've removed the extra Monte Carlo Primer section in the navigation sidebar (under "The Physics of Tardis") — it's already a subsection within "Physics Overview."
No content changes are being proposed.
Motivation and Context
These changes serve the broader goal of making the documentation as easy to digest for newcomers as possible. The fewer small inconsistencies there are, the smoother the experience of first looking at our documentation will be.
How Has This Been Tested?
I've built the docs locally, and nothing seems to have broken.
Screenshots (if appropriate):
Types of changes
Checklist: