Move docs to readme #8
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
ericphanson
reviewed
Apr 11, 2024
| @@ -92,10 +92,3 @@ jobs: | |||
| files: lcov.info | |||
| flags: WeakKeyIdDicts | |||
| token: ${{ secrets.CODECOV_TOKEN }} | |||
| # - name: Percy Upload | |||
There was a problem hiding this comment.
I would just delete this, I can't see us needing it on this repo
ericphanson
approved these changes
Apr 11, 2024
There was a problem hiding this comment.
moving to the README sounds good.
I think it would be nice to flesh out the readme a bit more, e.g. linking to WeakKeyDicts in the julia manual and to IdDicts, mentioning the limitation that keys must satisfy ismutable(key) == true, mentioning how object identity is used (not hashing) etc. That doesn't need to be in this PR though.
Closed
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 repo is trivial enough that I'm just including the docs in the readme.