fix/chore: update documentation of the file format#7
Merged
fpvandoorn merged 1 commit into1000-plus:mainfrom Dec 16, 2024
Merged
fix/chore: update documentation of the file format#7fpvandoorn merged 1 commit into1000-plus:mainfrom
fpvandoorn merged 1 commit into1000-plus:mainfrom
Conversation
physikerwelt
approved these changes
Dec 6, 2024
fpvandoorn
reviewed
Dec 9, 2024
README.md
Outdated
| - "S": standard library | ||
| - "L": main (biggest) mathematical library (afp, hol light outside standard library, mathcomp, mathlib, mml, set.mm) | ||
| - "X": external to the main or standard library (e.g. a dedicated repository) | ||
| * `identifiers`: list of theorems for a particular proof assistant; strongly recommended for "S" or "L" formalizations |
Contributor
There was a problem hiding this comment.
Do we want to track the identifier in this repository? I would prefer to have less information here, so that it doesn't have to be updated frequently.
Otherwise LGTM
Contributor
Author
There was a problem hiding this comment.
Updated now. Merging #6 first makes more sense logically.
grunweg
added a commit
to grunweg/1000-plus.github.io
that referenced
this pull request
Dec 16, 2024
- the entry for the Stone-Weierstrass theorem was outdated; update the URL - remove the 'identifiers' field from this and the continuum hypothesis entry (which are the only occurrences of these fields): in 1000-plus#7, the identifiers fields will be removed from the README.
5b265cd to
3a0811b
Compare
Contributor
Author
|
Depends on #6, and a rebase. Ping me once the former PR is in, then I can do the latter. |
Having a specification of the file format is great and really helpful! The current version is sometimes imprecise, sometimes incomplete (e.g. dangling sentences) and sometimes outdated. Correct all three. In addition, remove (any implicit mention of) the 'identifiers' field from the README: these are more unstable; we prefer to track stable URLs (which point to the respective theorems) rather than identifiers which become outdated more quickly. Found while implementing a more typed parser for this, for use in synchronising this database with a file of formalisations in mathlib.
3a0811b to
f18bb31
Compare
Contributor
Author
|
Rebased: from my side, this is ready to be merged. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Having a specification of the file format is great and really helpful!
The current version is sometimes imprecise, sometimes incomplete
(e.g. dangling sentences) and sometimes outdated. Correct all three.
In addition, remove (any implicit mention of) the 'identifiers' field from
the README: these are more unstable; we prefer to track stable URLs
(which point to the respective theorems) rather than identifiers which become
outdated more quickly.
Found while implementing a more typed parser for this, for use in synchronising
this database with a file of formalisations in mathlib.