Skip to content

doc URLs refer to hydra, not github #301

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.

Sign up for GitHub

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
matthewhammer merged 2 commits into from
Apr 11, 2019
Merged

doc URLs refer to hydra, not github #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55e5d0d
doc URLs refer to hydra, not github
matthewhammer Apr 11, 2019
0dfd948
minor Makefile cleanup
matthewhammer Apr 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ charlie.go("charlie", server);

## Syntax

See [here](design/Syntax.md).
See [here](design/Syntax.html).


## Semantics
Expand All @@ -382,4 +382,4 @@ TODO...

## Implementation

See [here](design/Implementation.md)
See [here](design/Implementation.html)
70 changes: 4 additions & 66 deletions stdlib/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,9 @@ ASC=../src/asc
OUTDIR=_out
DOCDIR=doc
MDofAS=./markdown-of-actorscript.py
MDofMD=./markdown-of-markdown.py
PANDOC=pandoc

## VT100 stuff
#HRULE="\x1b[2;34m----------------------------------------------------------------\x1b[0m"
#MODULE_NAME="\x1b[1;32mModule:\x1b[1;34m"
#BEGIN="\x1b[0;1mBegin...\x1b[0m"
#DONE="\x1b[1mDone.\n"$(HRULE)
#MODULE_NAME_COLOR="\x1b[0;1;34m"
#NO_COLOR="\x1b[0m"

# Add new module targets here:
MODULES=\
Hash \
Expand Down Expand Up @@ -100,69 +93,42 @@ $(DOCDIR):
$(DOCDIR)/README.md: README.md | $(DOCDIR)
@echo "<!-- **[ DO NOT EDIT -- GENERATED by a Makefile, on `date` ]** -->" > $@
@echo "" >> $@
@cat $< >> $@
$(MDofMD) $< >> $@

$(DOCDIR)/examples/produce-exchange/: README.md
@mkdir -p $@

$(DOCDIR)/examples/produce-exchange/README.md: examples/produce-exchange/README.md | $(DOCDIR)/examples/produce-exchange/
@echo "<!-- **[ DO NOT EDIT -- GENERATED by a Makefile, on `date` ]** -->" > $@
@echo "" >> $@
@cat $< >> $@
$(MDofMD) $< >> $@

$(OUTDIR)/Hash.out: prelude.as hash.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/List.out: prelude.as list.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/ListTest.out: prelude.as list.as listTest.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/AssocList.out: prelude.as list.as assocList.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/Trie.out: prelude.as hash.as list.as assocList.as trie.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/DocTable.out: prelude.as hash.as list.as assocList.as trie.as docTable.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/Set.out: prelude.as hash.as list.as assocList.as trie.as set.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/SetDb.out: prelude.as hash.as list.as assocList.as trie.as set.as setDb.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/SetDbTest.out: prelude.as hash.as list.as assocList.as trie.as set.as setDb.as setDbTest.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

PRODUCE_EXCHANGE_SRC=\
prelude.as hash.as list.as assocList.as trie.as docTable.as \
Expand All @@ -173,44 +139,16 @@ PRODUCE_EXCHANGE_SRC=\

$(OUTDIR)/ProduceExchange.out: $(PRODUCE_EXCHANGE_SRC) \
examples/produce-exchange/test/simpleSetupAndQuery.as | $(OUTDIR)
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)

$(OUTDIR)/ProduceExchange.wasm: $(PRODUCE_EXCHANGE_SRC) | $(OUTDIR)
$(ASC) -c --dfinity -o $@ $(filter-out $(OUTDIR), $^)

$(DOCDIR)/%.md: %.as $(MDofAS) | $(DOCDIR)
@echo "<!-- **[ DO NOT EDIT -- GENERATED by a Makefile, on `date` ]** -->" > $@
@echo "<!-- **[ Do not edit; This file was machine-generated on `date`. ]** -->" > $@
@echo "" >> $@
@echo "" >> $@
$(MDofAS) $< >> $@

$(DOCDIR)/%.html: $(DOCDIR)/%.md
$(PANDOC) -f gfm $^ > $@


#########################################################################################
# TODO(Matthew): Figure out why this "compressed" version of the rules doesn't work.

# $(OUTDIR)/List.out: $(OUTDIR) list.as ; @$(doModule)

# $(OUTDIR)/ListTest.out: $(OUTDIR) list.as listTest.as ; @$(doModule)

# $(OUTDIR)/Trie.out: $(OUTDIR) list.as trie.as ; @$(doModule)

# $(OUTDIR)/Set.out: $(OUTDIR) list.as trie.as set.as ; @$(doModule)

# $(OUTDIR)/SetDb.out: $(OUTDIR) list.as trie.as set.as setDb.as ; @$(doModule)

# $(OUTDIR)/SetDbTest.out: $(OUTDIR) list.as trie.as set.as setDb.as setDbTest.as ; @$(doModule)

# $(OUTDIR)/ProduceExchange.out: $(OUTDIR) list.as trie.as produceExchange.as ; @$(doModule)

# define doModule =
# @echo $(MODULE_NAME) $(basename $(notdir $@))
# @echo $(BEGIN)
# $(ASC) -r $(filter-out $(OUTDIR), $^) > $@
# @echo $(DONE)
# endef
8 changes: 4 additions & 4 deletions stdlib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ of the [produce exchange example](https://github.com/dfinity-lab/actorscript/tre

See also, the [library modules by priority](#library-modules-by-priority).

[`DocTable`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/docTable.md)
[`DocTable`]($DOCURL/docTable.html)
----------

A _document table_ abstracts over a **mutable collection of _documents_**,
Expand All @@ -36,17 +36,17 @@ See also
[`Trie`](#trie)
and [`AssocList`](#assoclist).

[`Trie`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md)
[`Trie`]($DOCURL/trie.html)
----------

Represent a finite map with a _canonical binary tree_, based on hashing each key.

[`AssocList`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/assocList.md)
[`AssocList`]($DOCURL/assocList.html)
------------

Represent a finite map with an _association list_ a list of key-value pairs.

[`List`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/list.md)
[`List`]($DOCURL/list.html)
-----------

Linked lists.
Expand Down
22 changes: 11 additions & 11 deletions stdlib/docTable.as
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type information.
/**
Representation
================
A table is a finite map (currently a [Trie](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md)) mapping ids to documents.
A table is a finite map (currently a [Trie]($DOCURL/trie.html)) mapping ids to documents.

See also: [private state](#private-state).

Expand Down Expand Up @@ -100,7 +100,7 @@ class DocTable<Id,Doc,Info>(
`empty`
---------

See also [`Table.empty`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#empty)
See also [`Table.empty`]($DOCURL/trie.md#empty)

*/

Expand All @@ -112,7 +112,7 @@ class DocTable<Id,Doc,Info>(
`getTable`
---------

See also [`Table.copy`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#copy)
See also [`Table.copy`]($DOCURL/trie.md#copy)

*/

Expand All @@ -124,7 +124,7 @@ class DocTable<Id,Doc,Info>(
`addDoc`
---------

See also [`Table.insertFresh`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#insertfresh)
See also [`Table.insertFresh`]($DOCURL/trie.md#insertfresh)

*/

Expand All @@ -141,7 +141,7 @@ class DocTable<Id,Doc,Info>(
`updateDoc`
---------

See also [`Table.replace`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#insertfresh)
See also [`Table.replace`]($DOCURL/trie.md#insertfresh)

*/

Expand Down Expand Up @@ -196,7 +196,7 @@ class DocTable<Id,Doc,Info>(
`addInfo`
---------

See also [`Table.insertFresh`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#insertfresh)
See also [`Table.insertFresh`]($DOCURL/trie.md#insertfresh)

*/
addInfo(info:Id -> Info) : ?(Id, Doc) {
Expand All @@ -214,7 +214,7 @@ class DocTable<Id,Doc,Info>(
`rem`
---------

See also [`Table.removeThen`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#removeThen)
See also [`Table.removeThen`]($DOCURL/trie.md#removeThen)

*/

Expand Down Expand Up @@ -256,7 +256,7 @@ class DocTable<Id,Doc,Info>(
`getDoc`
---------

See also [`Table.find`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#find)
See also [`Table.find`]($DOCURL/trie.md#find)

*/

Expand All @@ -280,7 +280,7 @@ class DocTable<Id,Doc,Info>(
`count`
---------

See also [`Table.count`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#count)
See also [`Table.count`]($DOCURL/trie.md#count)
*/

count() : Nat {
Expand All @@ -291,7 +291,7 @@ class DocTable<Id,Doc,Info>(
`allDoc`
---------

See also [`Table.toArray`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#toarray)
See also [`Table.toArray`]($DOCURL/trie.md#toarray)
*/

allDoc() : [Doc] {
Expand All @@ -303,7 +303,7 @@ class DocTable<Id,Doc,Info>(
`allInfo`
---------

See also [`Table.toArray`](https://github.com/dfinity-lab/actorscript/blob/stdlib-examples/design/stdlib/trie.md#toarray)
See also [`Table.toArray`]($DOCURL/trie.md#toarray)
*/

allInfo() : [Info] {
Expand Down
Loading