search

networkx / networkx-metis

NetworkX Addon to allow graph partitioning with METIS
Other
79 stars 21 forks source link

Minor doc fixes #55

Closed SanketDG closed 9 years ago

SanketDG commented 9 years ago

This fixes the warnings that appear in https://readthedocs.org/builds/networkx-metis/3214597/ and some minor ambiguities.

Also, I really doubt the fact that the docs have to follow the exact format of it's parent project. Do we really need to have a section titled "The Python Programming Language"? This is a fairly new project, so removing "Who uses Networkx-METIS" seems natural to me.

All in all, I feel a lot of parts need to be changed in the docs where we are following NetworkX, but largely going out of path what this project actually is. It's a good practice to follow the parent project, but NetworkX and NetworkX-METIS are very different projects from a high-level point of view IMHO.

OrkoHunter commented 9 years ago

Frankly speaking, the overview part is simply following the NetworkX documentation and I see no harm in that. I think NetworkX holds all the grounds for its add-ons which simply provide APIs for one or more functionality. That's why I don't like calling both of them two "different projects". However, there are many redundant information in the overview, which sure can be removed e.g. "Who uses NetworkX-METIS".

SanketDG commented 9 years ago

I will want to amend my last sentence now, I believe they are different because of their scope and size, NetworkX is huge in size and provides large amount of functions and classes in its API. NXMETIS provides just a subset of the functionality that NetworkX provides.

From overview:

I find the whole section of the Python Programming Language to be redundant. NetworkX came up in 2005, when adoption of Python was in its infancy. For a 2015 add-on of a fairly popular python package,the information is redundant. Also we are suggesting a book from 2003. Most people will only discover NetworkX-METIS after NetworkX, also stating the pros of python in 2015 is unnecessary.

Information on NetworkX development is found at the NetworkX Developer Zone at Github

I wouldn't use the word "Developer Zone" but this can be taken with a grain of salt.

OrkoHunter commented 9 years ago

This is ready to go.