fix docs #321
fix docs #321
Conversation
LucaMarconato
commented
Jul 13, 2023
•
LucaMarconato
commented
- Added installation instructions for M1/M2
- Added explicit links to the docs and to the repos in the docs landing page (feedback from @ilia-kats)
for more information, see https://pre-commit.ci
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #321 +/- ##
=======================================
Coverage 90.75% 90.75%
=======================================
Files 36 36
Lines 4630 4630
=======================================
Hits 4202 4202
Misses 428 428 |
| @@ -46,9 +64,19 @@ Alternative you can clone the repository and do an editable install with: | |||
| pip install -e . | |||
| ``` | |||
|
|
|||
| This is the reccommended way to install the package in case in which you want to contribute to the code. To update the package you can use `git pull`. | |||
| This is the reccommended way to install the package in case in which you want to contribute to the code. In this case, to subsequently update the package you can use `git pull`. | |||
There was a problem hiding this comment.
In that case, wouldn't we prefer people to create a fork first?
There was a problem hiding this comment.
| This is the reccommended way to install the package in case in which you want to contribute to the code. In this case, to subsequently update the package you can use `git pull`. | |
| An editable installation is the best option if you want to contribute to the development of spatialdata. | |
| Check out our [contributing guide](https://spatialdata.scverse.org/en/latest/contributing.html). |
explaining forking goes beyond the scope of installation instructions.
But we can use the opportunity to funnel people to the development guide.
There was a problem hiding this comment.
Yes in any case for Numfocus we do require a contributors guide or another option would be to create a complete installation guide, similar to napari. All I am saying is that we do not necessarily want people to contribute by directly installing from main in this repo and then pushing their code. This was just there for the initial developers.
There was a problem hiding this comment.
Thanks for the comments. It's hidden but it's there: https://github.com/scverse/spatialdata/blob/main/docs/contributing.md.
I will modify installation.md to quickly mentione forks.
