Skip to content

Improved installation section formatting in README - #753

Open
rakshitha-dotpy wants to merge 1 commit into
icesat2py:developmentfrom
rakshitha-dotpy:development
Open

Improved installation section formatting in README#753
rakshitha-dotpy wants to merge 1 commit into
icesat2py:developmentfrom
rakshitha-dotpy:development

Conversation

@rakshitha-dotpy

Copy link
Copy Markdown

Improved the installation section in README by making formatting clearer and more readable.

@github-actions

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on this branch for commit c1207d8

I will automatically update this comment whenever this PR is modified

@weiji14 weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @rakshitha-dotpy, could you maybe keep the URL links, and try to preserve the code blocks (mentioned below)? We also have some install docs at https://github.com/icesat2py/icepyx/blob/development/doc/source/getting_started/install.rst if you want to try improving that too. Thanks!

Comment thread README.rst
Comment on lines -85 to +84
conda install icepyx
Conda Install:
conda install icepyx

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We do want to keep the indent here to make it clear it is a terminal command rather than just text.

Before:

Image

After:

Image

Maybe try using triple backticks (```) instead?

@JessicaS11

Copy link
Copy Markdown
Member

Thanks, @rakshitha-dotpy for helping us improve our installation instructions! Will you be able to make the changes requested by @weiji14?

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