-
Notifications
You must be signed in to change notification settings - Fork 254
[ fix #1743 ] move README to doc/
directory
#2184
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
00dc06c
[ admin ] dev playground
gallais 7eaabc2
[ fix #1743 ] move README to doc/ directory
gallais 98843ee
[ fix ] whitespace violations
gallais 8c055de
[ ci ] update to cope with new doc/ directory
gallais dd6cf79
[ cleanup ] remove stale reference to travis.yml
gallais ad47e19
[ admin ] update README-related instructions
gallais 04f3be1
[ admin ] fix build badges
gallais 561d924
[ fix ] `make test` build
gallais ec1c00d
Merge branch 'master' into issue1743
MatthewDaggitt 059c659
Merge branch 'master' into issue1743
MatthewDaggitt f7f8e5d
Moved contents of notes/ to doc/
MatthewDaggitt 5f3f0b3
Added CHANGELOG entry
MatthewDaggitt 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
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Development playground | ||
|
||
This directory allows you to develop modules against the current dev | ||
version of the stdlib as it currently sits in `src/`. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
name: standard-library-dev | ||
include: . ../src | ||
flags: | ||
--warning=noUnsupportedIndexedMatch | ||
jamesmckinna marked this conversation as resolved.
Show resolved
Hide resolved
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
name: standard-library-doc | ||
include: . ../src | ||
flags: | ||
--warning=noUnsupportedIndexedMatch |
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
So, I've been thinking a lot (if not 'hard') about this, and I don't know if it makes more, or less, sense, to have the
README.*
modules in adoc
directory, or in good-oldREADME
as a top-level directory, and simply bump all the modules names 'up' one level, by having what would then beREADME.agda
import fromAxiom
rather thanREADME.Axiom
etc.Alternatively, leave the entire existing
README/
directory alone, but simply have itsblah.agda-lib
point at... the right directories (and here is where I get confused about what those should be.... ../src
as already, or. ./README ../src
(I guess this latter is subsumed by the former?)In other words, the change could be less invasive still simply by moving toplevel
README.agda
toREADME/
, and updating theGNUmakefile
and.github/tooling
scripts?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.
Many modules in
README
have identical paths as the modules from the standard library (e.g.README/Function/Reasoning.agda
andsrc/Function/Reasoning.agda
,README/Data/List.agda
andsrc/Data/List.agda
, etc.). If theREADME.
prefix in the module paths is removed, I wonder how Agda resolves the module?Uh oh!
There was an error while loading. Please reload this page.
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.
I think because the
include
directive line will ensure that those indoc/README
will get searched for before trying to look for them insrc
?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.
The
include
in this PR looks good to me. What I don't understand is how your alternative approach works. (this one:I might be wrong, but including
../README
directory before../src
ininclude:
sounds like modules inREADME
will shadow those that have the same name insrc
. Without theREADME.
prefix in the module paths, how could files likeREADME.Data.List.Relation.Binary.Equality
that importData.Nat
continue to work? Wouldn'tData.Nat
incorrectly refers toREADME.Data.Nat
?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.
Ah... ok, perhaps you're right.
In any case, I would prefer simply to have the
doc
directory be calledREADME
instead. Or are you saying that such a solution also would not work?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.
I think that should work.