Skip to content
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

Semantics of HyperSeq/RaceSeq appear to be undocumented #1897

Closed
zoffixznet opened this issue Apr 6, 2018 · 2 comments
Closed

Semantics of HyperSeq/RaceSeq appear to be undocumented #1897

zoffixznet opened this issue Apr 6, 2018 · 2 comments
Labels
docs Documentation issue (primary issue type)

Comments

@zoffixznet
Copy link
Contributor

Don't see the behaviour of calls on HyperSeq/RaceSeq documented anywhere

All I know about is this spreadsheet jnthn++ prepared before implementing them:
https://docs.google.com/spreadsheets/d/1kpSb8LoskHSbM1FQvWdQ269rlRkU8vh5A_ElpN3Qay4/edit#gid=0

IMO, it makes sense to just document those two types and list all the methods and how they behave, but I vaguely recall jnthn saying Hyper/RaceSeqs are implementation detail and shouldn't be documented or something? I forget.

@zoffixznet zoffixznet added the docs Documentation issue (primary issue type) label Apr 6, 2018
@JJ
Copy link
Contributor

JJ commented Apr 6, 2018

The other reference to HyperSeq is in #1803. It might have been discussed in general, though.

@jnthn
Copy link
Contributor

jnthn commented Apr 7, 2018

HyperSeq and RaceSeq themselves are user-facing. It's the hyper batcher and so forth roles that I wish to keep implementation-defined for now.

Documenting the semantics of operations of a HyperSeq and RaceSeq makes sense. The spreadsheet is an idea of where we want to end up, but of course only a fraction of that is implemented now (map, grep), so it's probably best just to implement ones that are actually done.

@JJ JJ added the TPF Grant label Apr 7, 2018
@JJ JJ removed the JJ TPF Grant label May 14, 2018
JJ added a commit that referenced this issue Jul 26, 2019
@JJ JJ closed this as completed in 5b8e85c Jul 26, 2019
coke added a commit that referenced this issue Jul 26, 2019
xt/type-graph.t needs to know if something is a role, and
will fail if assumes incorrectly. Be explicit.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type)
Projects
None yet
Development

No branches or pull requests

3 participants