Editing/Reviewing #95

luizperes · 2018-03-21T04:55:02Z

This PR brushes up the files CONTRIBUTING and README. More edits will be done later :)

This closes #93

codecov-io · 2018-03-21T04:59:28Z

Codecov Report

Merging #95 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #95   +/-   ##
======================================
  Coverage    83.7%   83.7%           
======================================
  Files           8       8           
  Lines         362     362           
======================================
  Hits          303     303           
  Misses         59      59

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7768525...b95e5bb. Read the comment docs.

ryukinix · 2018-03-21T05:09:17Z

Thank you for this, @luizperes! This indeed helps.

ryukinix

This is a nice review of docs, thanks. Really you made it more pleasant and readable. I have only one problem, can you change make install to pip install --user .? I know that this assumes that users should have pip, however, make install try install globally which needs super-user permissions... this is bad and doesn't reflects well the text written.

ryukinix · 2018-03-21T05:10:09Z

CONTRIBUTING.md


-Also feel free to open new issues for any bug you found, features you think would be nice to have or questions in general.
+- 1. Find an issue [here](https://github.com/ryukinix/mal/issues).


This is awesome. Really great. Algorithmic steps makes thing more clear

ryukinix · 2018-03-21T05:10:35Z

CONTRIBUTING.md

+- 3. Mention (by commenting on the issue) that you want to take it.
+- 4. Fork it and create a new branch out of `master`.
+- 5. Work on it.
+- 6. Submit a pull request.


Yes, please, submit PRs, do not die on the cold planet of ideas.

ryukinix · 2018-03-21T05:11:13Z

CONTRIBUTING.md


 For more information see [Development Mode](http://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode).

-# Running without need to install
+# Running mal without installing it


Thanks, this really makes things more clear.

ryukinix · 2018-03-21T05:14:38Z

README.md


 ```
 make install
 ```

-Probably we'll need have super-user permissions, but I'd recommend you
-to install inside of a virtualenv or use the `pip install --user' stuff.
+It is likely that `mal` will never need super-user permissions, but we recommend its


Actually this is a little misleading, because make install needs super-user permissions if we call inside of a virtualenv.
Probably the most correct way to fix all this thing is just point the manual installation as pip install --user . which will build the package and install in the userspace /home/$USER.

ryukinix · 2018-03-21T05:14:53Z

README.md

-If you're using the archlinux distro this project has been packaged and uploaded to
-the AUR as [python-mal-git](https://aur.archlinux.org/packages/python-mal-git).
+This project has been packaged and uploaded to the AUR as
+[python-mal-git](https://aur.archlinux.org/packages/python-mal-git) in case you're using an archlinux distro.


Indeed better

ryukinix · 2018-03-21T05:15:29Z

README.md


 ### Using The Interface

-When `mal` is executed without any arguments the help message is displayed:
+When `mal` is executed without any arguments, a help message is displayed:


luizperes · 2018-03-21T05:50:49Z

I have changed the points you mentioned. :) I believe it is much better now, please let me know what you think!

ryukinix

Almost there.

ryukinix · 2018-03-21T06:22:10Z

README.md

+This project has been packaged and uploaded to the AUR as
+[python-mal-git](https://aur.archlinux.org/packages/python-mal-git) in case you're using an archlinux distro.
+
+You may install it using an AUR wrappers such `yaourt` or `pacaur`, making


Please, rollback that section about Arch Linux without details, I already remove that in earlier version. As I said for you, README.md was the doc more updated, I forgot to remove that from sphinx docs (please, remove from that too)

ryukinix · 2018-03-21T06:23:17Z

README.md

@@ -60,27 +60,54 @@ pip install --user mal

 ### Manual Installation

-Clone this project and run inside it:
+Clone this project and inside it run:

 ```
 make install


You miss that part that I said before? Please, remove that I write this instead: pip install --user .

luizperes · 2018-03-21T16:11:55Z

That sounds good! Will change the it later tonight :)

luizperes · 2018-03-22T06:03:10Z

Have just done it. Please let me know what you think @ryukinix

ryukinix · 2018-03-22T08:15:44Z

README.md


 ```
-make install
+pip install --user .


ryukinix · 2018-03-22T08:16:21Z

Thanks for this.

bradenbest · 2018-03-22T12:26:17Z

Tell you what, to make up for all the pestering, I'll start working on my own proofreading pull request some time later today. Looking over the docs, I've already noticed some miscellaneous typos chiefly in the grammar and sentence flow departments. As a native English-speaker and friendly neighborhood grammar nazi, I'll put the docs through the same OCD edit re-edit proofreading rigor that I put my YouTube comments through, but without making it 18 paragraphs long!

bradenbest · 2018-03-22T23:08:48Z

@ryukinix Quick fact check: this is actually a fork of pushrax/mal and not from scratch, correct? It doesn't say so on the project page (where it usually says "forked from xxxx"), so I want to be sure.

Original: This project was initially inspired in pushrax/mal.
Planned edit: This project is a fork of pushrax/mal, which seems to have fallen out of maintenance.

ryukinix · 2018-03-22T23:24:36Z

@bradenbest
In some way, yes, we can look this as a some type of fork, but not a GitHub fork however.

I indeed based most of the initial features on pushrax/mal, as the API and inc/dec stuff, but we have uncorrelated git histories, which can be confusing saying that is a fork on README.md. I based this works on pushrax/mal mainly because I was needing a mal CLI software and all what I found was pushrax/mal (and because that I'm referring about him on README.md until today).

I think we have more important stuff to take care and the way this fact is presented on README it's good enough describing what happened.

bradenbest · 2018-03-22T23:49:18Z

Got it, I'll say it's an "unofficial fork" to prevent people from thinking it's a direct GitHub fork.

bradenbest · 2018-03-22T23:50:05Z

Also, the README is lookin' pretty good. When I finish it, I'll submit a pull request and start working on the other docs

luizperes added 2 commits March 20, 2018 21:23

Editing contributing file

f48dbe7

Reviewing and editing readme file

a6e8269

ryukinix self-requested a review March 21, 2018 05:07

ryukinix assigned luizperes Mar 21, 2018

ryukinix added the type: docs label Mar 21, 2018

ryukinix added this to the v0.4.0 milestone Mar 21, 2018

ryukinix approved these changes Mar 21, 2018

View reviewed changes

luizperes added 2 commits March 20, 2018 22:33

Finished reviewing and editing docs

7622618

Final touches

f35cb18

ryukinix requested changes Mar 21, 2018

View reviewed changes

ryukinix mentioned this pull request Mar 21, 2018

Update sphinx docs at /docs before official 0.4.0 release #93

Closed

Making changes as defined on comments

b95e5bb

ryukinix approved these changes Mar 22, 2018

View reviewed changes

README.md

```

make install

pip install --user .

Copy link

Owner

ryukinix Mar 22, 2018

Choose a reason for hiding this comment

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

👍

ryukinix merged commit fa9024d into ryukinix:master Mar 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editing/Reviewing #95

Editing/Reviewing #95

luizperes commented Mar 21, 2018 •

edited by ryukinix

Loading

codecov-io commented Mar 21, 2018 •

edited

Loading

ryukinix commented Mar 21, 2018

ryukinix left a comment

ryukinix Mar 21, 2018

ryukinix Mar 21, 2018

ryukinix Mar 21, 2018

ryukinix Mar 21, 2018

ryukinix Mar 21, 2018

ryukinix Mar 21, 2018

luizperes commented Mar 21, 2018

ryukinix left a comment

ryukinix Mar 21, 2018 •

edited

Loading

ryukinix Mar 21, 2018

luizperes commented Mar 21, 2018

luizperes commented Mar 22, 2018

ryukinix Mar 22, 2018

ryukinix commented Mar 22, 2018

bradenbest commented Mar 22, 2018 •

edited

Loading

bradenbest commented Mar 22, 2018

ryukinix commented Mar 22, 2018 •

edited

Loading

bradenbest commented Mar 22, 2018

bradenbest commented Mar 22, 2018


		Also feel free to open new issues for any bug you found, features you think would be nice to have or questions in general.
		- 1. Find an issue [here](https://github.com/ryukinix/mal/issues).

Editing/Reviewing #95

Editing/Reviewing #95

Conversation

luizperes commented Mar 21, 2018 • edited by ryukinix Loading

codecov-io commented Mar 21, 2018 • edited Loading

Codecov Report

ryukinix commented Mar 21, 2018

ryukinix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luizperes commented Mar 21, 2018

ryukinix left a comment

Choose a reason for hiding this comment

ryukinix Mar 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luizperes commented Mar 21, 2018

luizperes commented Mar 22, 2018

Choose a reason for hiding this comment

ryukinix commented Mar 22, 2018

bradenbest commented Mar 22, 2018 • edited Loading

bradenbest commented Mar 22, 2018

ryukinix commented Mar 22, 2018 • edited Loading

bradenbest commented Mar 22, 2018

bradenbest commented Mar 22, 2018

luizperes commented Mar 21, 2018 •

edited by ryukinix

Loading

codecov-io commented Mar 21, 2018 •

edited

Loading

ryukinix Mar 21, 2018 •

edited

Loading

bradenbest commented Mar 22, 2018 •

edited

Loading

ryukinix commented Mar 22, 2018 •

edited

Loading