search

Kemsekov / GraphSharp

GraphSharp is a tool to study and use knowledge of graph theory in C#!
MIT License
40 stars 5 forks source link

Make documentation cleaner #12

Open Kemsekov opened 2 years ago

Kemsekov commented 2 years ago

You are really bad at English, which is fine by itself, but my eyes bleed when I am trying to read your documentation. Pls do something about it.

I am taking about how Visitor works. It is not obvious from what you written in methods description. It is not obvious how selector affect next generation of nodes and what role Visit method has.

Also it is not obvious what IPropagator is and what it is doing.

You did little-to-none in order to explain what Graph.Step doing, and why it is even named step, if it using IPropagator? Maybe rename ot to Propagate?

Also add better description to README.md

Kemsekov commented 2 years ago

I am refactored it a bit and fixed comments but I am just not competent enough to do it. Will polish it from time to time..