refactor documentation #38
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
Closed
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #38 +/- ##
==========================================
- Coverage 81.55% 76.97% -4.59%
==========================================
Files 28 28
Lines 1681 1681
==========================================
- Hits 1371 1294 -77
- Misses 310 387 +77 ☔ View full report in Codecov by Sentry. |
kris-brown
reviewed
Jan 18, 2024
docs/src/index.md
Outdated
| ``` | ||
|
|
||
| #### Colimit-of-representables instantiation (`@acset_colim``) |
docs/src/index.md
Outdated
| ``` | ||
|
|
||
| This documentation provides a basic guide to using the AlgebraicRewriting package in Julia. |
There was a problem hiding this comment.
Does this line belong at the beginning?
There was a problem hiding this comment.
Yeah, you're right. It was a straggler. Moved it up.
docs/src/index.md
Outdated
| If using the **static** approach, you must fully specify the ACSet functors and natural transformation. Here is a rule that defines the ACSet statically. | ||
|
|
||
| In this example, the rule swaps player between two teams. |
There was a problem hiding this comment.
Yeah, that is. It was intended to simulate a trade of players, one from each team. I revised the sentence to hopefully make it clearer.
|
also I suspect that |
|
Looks great to me, thanks! |
mehalter
reviewed
Jan 23, 2024
| repo="github.com/AlgebraicJulia/AlgebraicRewriting.jl.git", | ||
| branch="gh-pages", | ||
| devbranch="dev" |
There was a problem hiding this comment.
This should not be dev, this should be main
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 updates the documentation found on https://algebraicjulia.github.io/AlgebraicRewriting.jl/dev/.
More specifically, this: