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

Format the getting started section to make it clearer #1603

Merged
merged 4 commits into from
Jan 10, 2022

Conversation

simonzhaoms
Copy link
Collaborator

@simonzhaoms simonzhaoms commented Dec 31, 2021

Description

The Getting Started section in README.md is a little messy. For example:

  1. Register your (conda or virtual) environment with Jupyter:

    python -m ipykernel install --user --name my_environment_name --display-name "Python (reco)"
  2. Start the Jupyter notebook server

    jupyter notebook

will look better than:

  1. Register your (conda or virtual) environment with Jupyter:
python -m ipykernel install --user --name my_environment_name --display-name "Python (reco)"
  1. Start the Jupyter notebook server
jupyter notebook

Please compare getting started@simonz/format-getting-started with getting started@staging

Related Issues

Checklist:

  • I have followed the contribution guidelines and code style for this project.
  • I have added tests covering my contributions.
  • I have updated the documentation accordingly.
  • This PR is being made to staging branch and not to main branch.

@codecov-commenter
Copy link

codecov-commenter commented Dec 31, 2021

Codecov Report

Merging #1603 (dac495a) into staging (4982381) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           staging    #1603   +/-   ##
========================================
  Coverage    58.23%   58.23%           
========================================
  Files           84       84           
  Lines         8462     8462           
========================================
  Hits          4928     4928           
  Misses        3534     3534           
Flag Coverage Δ
pr-gate 58.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 4466f47...dac495a. Read the comment docs.

Copy link
Collaborator

@miguelgfierro miguelgfierro left a comment

Choose a reason for hiding this comment

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

LGTM

@miguelgfierro miguelgfierro merged commit 3af3212 into staging Jan 10, 2022
@miguelgfierro miguelgfierro deleted the simonz/format-getting-started branch January 10, 2022 14:51
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.

3 participants