Skip to content

87 doc extra installtions#90

Open
rogerkuou wants to merge 4 commits into
mainfrom
87_doc_extra_installtions
Open

87 doc extra installtions#90
rogerkuou wants to merge 4 commits into
mainfrom
87_doc_extra_installtions

Conversation

@rogerkuou
Copy link
Copy Markdown
Member

Fix #87

Updated both README and docs installation page.

@rogerkuou
Copy link
Copy Markdown
Member Author

rogerkuou commented May 18, 2026

Hi @Simon-van-Diepen, this is to fix a comment we get from the JOSS review. Could you please review this PR for me? thanks!

Copy link
Copy Markdown
Contributor

@Simon-van-Diepen Simon-van-Diepen left a comment

Choose a reason for hiding this comment

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

Just four minor comments, after that it's good to merge

Comment thread docs/setup.md

```sh
pip install 'sarxarray[demo]' # to run the demo notebook
pip install 'sarxarray[dev]' # to run the test suite
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
pip install 'sarxarray[dev]' # to run the test suite
pip install 'sarxarray[dev]' # to run the test suite and enable code quality checks for developers

Copy link
Copy Markdown
Member Author

@rogerkuou rogerkuou May 18, 2026

Choose a reason for hiding this comment

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

I think "run the test suite" already covers "enable code quality checks for developers". I will just keep it short here

Comment thread docs/setup.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This makes it seem like the license is expired

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Indeed, I updated the liscense description.

rogerkuou and others added 2 commits May 18, 2026 16:40
Co-authored-by: Simon-van-Diepen <44979564+Simon-van-Diepen@users.noreply.github.com>
@rogerkuou
Copy link
Copy Markdown
Member Author

Thanks @Simon-van-Diepen! I plan to merge this tomorrow. Feel free to have a last look if you want.

@sonarqubecloud
Copy link
Copy Markdown

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.

Document optional extras ([demo], [dev], [docs]) in README install section

2 participants