search

ITensor / NamedGraphs.jl

Extension of `Graphs.jl` to graphs with named vertices.
MIT License
6 stars 3 forks source link

README improvements #79

Closed emstoudenmire closed 5 months ago

emstoudenmire commented 5 months ago

This PR makes the following changes to the README file:

  1. fix a mistake at the beginning which refers to named edges, whereas it should be named vertices, correct?

  2. add a sentence explaining that the names could be strings, tuples of integers, or other things

  3. remove some extraneous empty lines

mtfishman commented 5 months ago

The README is actually generated from this file: https://github.com/ITensor/NamedGraphs.jl/blob/main/examples/README.jl using the instructions at the bottom of that file, can you make the edits to that file and then generate the new README?

mtfishman commented 5 months ago

Of course we should automate that process in a CI workflow but I haven't gotten around to that yet.

mtfishman commented 5 months ago

(That's why there is the weird extra lines, that's just how it gets generated.)

emstoudenmire commented 5 months ago

Sure thing – I just edited the examples/README.jl file and used the command at the bottom of it to regenerate the main README.jl

mtfishman commented 5 months ago

Thanks! No idea why it was referring to "edges" instead of "vertices"...

emstoudenmire commented 5 months ago

Maybe you were working on the NamedEdge type write before you wrote that? 😄