-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
initial commit for the metadata CEP #80
Open
CohenCyril
wants to merge
2
commits into
coq:master
Choose a base branch
from
CohenCyril:metadata
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
- Title: Adding MetaData to Coq | ||
|
||
- Drivers: @CohenCyril @palmskog @gares @TDiazT @pi8027 @ejgallego @SkySkimmer | ||
|
||
---- | ||
|
||
# Summary | ||
|
||
The purpose is to add several kind of metadata, attached to constants, | ||
modules, files, etc. | ||
|
||
|
||
# Motivation | ||
|
||
This metadata should be usable and used to enhance search, | ||
documentation generation, and build database for Coq libraries. | ||
|
||
|
||
# Detailed design | ||
|
||
## For search | ||
|
||
- adding docstrings (that search can grep inside) | ||
```coq | ||
#[docstring="foo is a dummy lemma"] | ||
Lemma foo : True. by []. Qed. | ||
``` | ||
- aliasing of statements so that search can find a statement which is | ||
convertible but not syntactically equal. | ||
```coq | ||
#[alias="forall x y, x * y = y * x"] | ||
Lemma mulrC : commutative mul. ... | ||
|
||
Search (_ * _ = _ * _). (* mulrC appears *) | ||
``` | ||
or | ||
```coq | ||
#[alias(unfold="commutative")] | ||
Lemma mulrC : commutative mul. ... | ||
``` | ||
and we could have several aliases (`#[alias=..., alias=..., ...]`). | ||
- Give a name from the litterature (searchable again) | ||
```coq | ||
#[name="Abel-Ruffini Theorem", name="Abel's Theorem"] | ||
Lemma unsolvable_quintic : ... | ||
``` | ||
- Have a way to refer to a bibliography from a definition or its proof | ||
E.g via a `#[ref="name"]` attribute with a bibtex (for example), | ||
shared accross one or several projects. | ||
|
||
# Drawbacks | ||
|
||
TODO | ||
|
||
# Alternatives | ||
|
||
TODO | ||
|
||
# Unresolved questions | ||
|
||
Where to store this? | ||
TODO |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.