Noissue - Update R documentation

Noissue - Update R documentation

[Vasily Kuznetsov, 2019-03-06 17:18:19]

Hi Rosie!

Improving this doc seems like a good idea, however explaining every possible
scenario independently gets a bit repetitive. What if we make the guide a bit
more modular and add some references(see below for concrete proposals)?

Do you think this would be easier/harder to follow?

@Stephan: what do you think?

Cheers,
Vasily

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst
File README.rst (right):

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst#newcode219
README.rst:219: Or install onto your system from source::
Perhaps we could make this a bit more comprehensive and also remove repetition
if we use the following structure:

- How to install from PyPI
- How to install from local source
- How to use a virtualenv:
  - Show both py2 and py3 way of creating a virtualenv, link to
https://virtualenv.pypa.io/en/latest/userguide/#usage and
https://docs.python.org/3/library/venv.html
  - Explain that we can use /path/to/venv/bin/pip to install packages into the
virtualenv.
- Show how to import stuff in R with and without a virtualenv, link to
https://rstudio.github.io/reticulate/articles/versions.html

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst#newcode222
README.rst:222: $ pip install --upgrade .
A simpler version would be:

    $ pip install -U /path/to/python-abp

Changing into the directory is not really necessary.

[rhowell, 2019-03-07 03:59:07]

Thanks for the feedback! I tried re-structuring as you (Vasily) suggested, and I
think I like it better also. Let me know if there's any other suggestions?

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst
File README.rst (right):

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst#newcode219
README.rst:219: Or install onto your system from source::
On 2019/03/06 17:18:19, Vasily Kuznetsov wrote:
> Perhaps we could make this a bit more comprehensive and also remove repetition
> if we use the following structure:
> 
> - How to install from PyPI
> - How to install from local source
> - How to use a virtualenv:
>   - Show both py2 and py3 way of creating a virtualenv, link to
> https://virtualenv.pypa.io/en/latest/userguide/#usage and
> https://docs.python.org/3/library/venv.html
>   - Explain that we can use /path/to/venv/bin/pip to install packages into the
> virtualenv.
> - Show how to import stuff in R with and without a virtualenv, link to
> https://rstudio.github.io/reticulate/articles/versions.html

Seems like it's starting to get complicated trying to cover every installation
use case, but hopefully this is an improvement. Oh, and is this what you meant
by 'both py2 and py3 ways of creating a virtualenv'?

https://codereview.adblockplus.org/30023558/diff/30023559/README.rst#newcode222
README.rst:222: $ pip install --upgrade .
On 2019/03/06 17:18:19, Vasily Kuznetsov wrote:
> A simpler version would be:
> 
>     $ pip install -U /path/to/python-abp
> 
> Changing into the directory is not really necessary.

Done.

[Vasily Kuznetsov, 2019-03-07 21:28:16]

Hi Rosie!

I like the way it is now: comprehensive and doesn't feel like we're repeating
the same thing several times. LGTM!

Cheers,
Vasily

[sporz, 2019-03-15 09:35:22]

LGTM! Learned quite a bit from you two today!