Skip to content

Commit 1e70f46

Browse files
authored
Merge pull request #120 from Islast/master
contributing docs updates
2 parents 8dfb892 + 18b8047 commit 1e70f46

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,4 +196,4 @@ And if you've found typos in this (or any other) page, you could consider submit
196196
[link_hatrackhome]: https://labhr.github.io/
197197
[link_hatrackidea]: http://hawthornlandings.org/2015/02/13/a-place-to-hang-your-hat/
198198
[link_hatrackcontributions]: http://opensource.com/life/15/10/octohat-github-non-code-contribution-tracker
199-
[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4
199+
[link_fixingtyposissue]: https://github.com/WhitakerLab/scona//issues/4

DEVELOPMENT_GUIDE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ The [development guide](#development-guide) deals with the specifics of contribu
1414

1515
### Installing in editable mode
1616

17-
Use `pip install -e git+https://github.com/WhitakerLab/scona.git` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.
17+
Use `pip install -e git+https://github.com/WhitakerLab/scona.git#egg=scona` to install scona in editable mode. This means that the python install of scona will be kept up to date with any changes you make, including switching branches in git.
1818

1919
### Linting
2020

2121
scona uses the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
2222
You can use [flake8](http://flake8.pycqa.org/en/latest/) to lint code.
2323
We're quite a young project (at time of writing in January 2019) and so we aren't going to be super hardcore about your linting!
2424
Linting should make your life easier, but if you're not sure how to get started, or if this is a barrier to you contributing to `scona` then don't worry about it or [get in touch](CONTRIBUTING.md#how-to-get-in-touch) and we'll be happy to help you.
25+
Feel free also to correct unlinted code in scona when you come across it!:sparkles:
2526

2627
### Writing docstrings
2728

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you don't want to bother reading the whole of this page, here are three place
2121
* To install `scona` as a python package with pip
2222

2323
```
24-
pip install git+https://github.com/WhitakerLab/scona.git
24+
pip install git+https://github.com/WhitakerLab/scona.git#egg=scona
2525
```
2626

2727
* Check out our [tutorial](tutorials/tutorial.ipynb) for examples of basic functionality.

0 commit comments

Comments
 (0)