README improvements #79
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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? |
|
Of course we should automate that process in a CI workflow but I haven't gotten around to that yet. |
|
(That's why there is the weird extra lines, that's just how it gets generated.) |
|
Sure thing – I just edited the |
mtfishman
reviewed
May 28, 2024
|
Thanks! No idea why it was referring to "edges" instead of "vertices"... |
|
Maybe you were working on the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes the following changes to the README file:
fix a mistake at the beginning which refers to named edges, whereas it should be named vertices, correct?
add a sentence explaining that the names could be strings, tuples of integers, or other things
remove some extraneous empty lines