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

A bunch of small dev-oriented documentation updates #120

Merged
merged 3 commits into from
Jan 3, 2024

Conversation

drewoldag
Copy link
Contributor

@drewoldag drewoldag commented Dec 22, 2023

Addressing requests in issue #51

Adding note about using mamba as a faster alternative to conda.
Mamba not conda so it's simpler
rail --help,
Explain why the instructions are what they are (pip vs. conda)
Explain the command-line tool (purpose, what this gives you) rather than just jumping into the commands
Change pip install to pip install -e .

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

@drewoldag drewoldag self-assigned this Dec 22, 2023
Copy link

codecov bot commented Dec 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e015e13) 100.00% compared to head (880653b) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #120   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@drewoldag drewoldag linked an issue Dec 22, 2023 that may be closed by this pull request
10 tasks
Copy link
Member

@OliviaLynn OliviaLynn left a comment

Choose a reason for hiding this comment

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

This looks great!

@drewoldag drewoldag merged commit 84eb587 into main Jan 3, 2024
6 checks passed
@drewoldag drewoldag deleted the issue/51/dev-oriented-instructions branch January 3, 2024 17:26
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.

Revise dev-oriented onboarding instructions
2 participants