OldGraphs.jl icon indicating copy to clipboard operation
OldGraphs.jl copied to clipboard

Examples on documentation

Open prcastro opened this issue 10 years ago • 4 comments

I have no prior experience in graphs, and don't know how to use this library to create a graph from scratch, get info from that graph and use some functions on it. It would be very useful to have some examples on the docs, clarifying these things to new users.

prcastro avatar Jun 01 '14 06:06 prcastro

I strongly support this suggestion. The documentation doesn't seem to include one example of how to actually construct a graph using this package.

mrtzh avatar Jan 18 '15 21:01 mrtzh

:+1: I also don't understand how to use this library, I'm trying to implement the artificial hydrocarbon network algorithm in Julia.

An artificial organic network is a set of graphs. Each graph represents a molecule with atoms as vertices and chemical bonds as edges.

I'm reading through Boost Graph Library documentation and examples right now, but I don't know C++ either! :worried:

Ismael-VC avatar Mar 02 '15 16:03 Ismael-VC

I strongly sympathize with the desire for more documentation, but it's not really clear how the expressed desire for more documentation will lead to the creation of more documentation given that the author of the package has other projects to work on. As always, there is one core limiting factor to Julia development: the supply of labor.

We sorely need additional people to join the labor supply pool. One way to join the labor supply pool is to read through the source code for this package until you understand the package well enough to document it. It's a long, tedious process that will likely take days to weeks of work, but it is the single best thing you can do to help Julia mature.

johnmyleswhite avatar Mar 02 '15 16:03 johnmyleswhite

@johnmyleswhite I understand and I'll try to do that, thanks!

Ismael-VC avatar Mar 02 '15 20:03 Ismael-VC