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

$*REPO and CompUnit::Repository::* classes not documented #502

Open
AlexDaniel opened this issue May 8, 2016 · 15 comments
Open

$*REPO and CompUnit::Repository::* classes not documented #502

AlexDaniel opened this issue May 8, 2016 · 15 comments
Assignees
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type)

Comments

@AlexDaniel
Copy link
Member

Code:

say WHAT $*REPO

Result:

(Installation)
@AlexDaniel AlexDaniel added the docs Documentation issue (primary issue type) label May 8, 2016
@jonathanstowe
Copy link
Contributor

I think this wants to be done with all the other CUR stuff, note also that it not always a CompUnit::Repository::Installation :

[jonathan@coriolanus doc.master]$ perl6 -Ilib -e 'say $*REPO.^name'
CompUnit::Repository::FileSystem
[jonathan@coriolanus doc.master]$ perl6  -e 'say $*REPO.^name'
CompUnit::Repository::Installation

@JJ
Copy link
Contributor

JJ commented Jan 27, 2018

There's not much about compunit in the documentation. Maybe create a new page?

@JJ JJ changed the title Installation not documented Installation class not documented Apr 17, 2018
@JJ
Copy link
Contributor

JJ commented Apr 18, 2018

@jonathanstowe I think that the main difference is that in the first case it's looking at the lib directory, and finding it does not have any .git in it. perl6 -I.. -e 'say $*REPO.^name' returns exactly the same.

@JJ
Copy link
Contributor

JJ commented Apr 18, 2018

@JJ JJ closed this as completed in 928050c Apr 19, 2018
@ugexe ugexe reopened this Jun 30, 2018
@ugexe
Copy link
Contributor

ugexe commented Jun 30, 2018

$*REPO is a linked list -- what it contains depends on where it is in the list. It has nothing to do with .git nor does it have anything to do with the directory a program is run it. At the risk of sounding harsh: nothing in the commit that closed this issue makes sense.

@JJ
Copy link
Contributor

JJ commented Jul 1, 2018

And what would make sense?

@ugexe
Copy link
Contributor

ugexe commented Jul 1, 2018

Some things that would make sense:

  1. revert the offending commit.
  2. ask what “makes sense” before commiting work that isn’t understood.

And I hate to say it but this was part of grant related work so it looks even worse.

@JJ JJ changed the title Installation class not documented CompUnit::Repository::* classes not documented Jul 1, 2018
@JJ JJ changed the title CompUnit::Repository::* classes not documented $*REPO and CompUnit::Repository::* classes not documented Jul 1, 2018
JJ added a commit that referenced this issue Jul 1, 2018
JJ added a commit to JJ/my-raku-examples that referenced this issue Jul 1, 2018
JJ added a commit that referenced this issue Jul 1, 2018
JJ added a commit that referenced this issue Jul 1, 2018
It was missing so far, with compunit pointing to the definition of
several compilation units. Once again, @jnthn document is essential,
and definition sentence basically copypasted from there. Refs #502.
JJ added a commit to JJ/my-raku-examples that referenced this issue Jul 1, 2018
JJ added a commit to JJ/my-raku-examples that referenced this issue Jul 1, 2018
@niner
Copy link
Contributor

niner commented Jul 2, 2018

JJ: please have a look at https://github.com/rakudo/rakudo/blob/master/docs/module_management.md
and http://niner.name/talks/A%20look%20behind%20the%20curtains%20-%20module%20loading%20in%20Perl%206/
"Not documented" has not been entirely accurate.

@JJ
Copy link
Contributor

JJ commented Jul 2, 2018 via email

@ohmycloud
Copy link

There are two broken links in the https://docs.perl6.org/type/CompUnit::Repository::Installation page:
CompUnit::Repository and CompUnits, shows 404 when clicked.

@lizmat
Copy link
Collaborator

lizmat commented May 4, 2019

With the addition of lemmas for CompUnit::Repository and CompUnit, I think the broken links are now fixed.

@rafaelschipiura
Copy link
Contributor

$REPO and CompUnit::Repository:: have been documented, closing the bug report.

@JJ
Copy link
Contributor

JJ commented May 6, 2019

Most classes are still not documented; CompUnit::Repository is not either for the time being. Sorry, I'm reopening.

@JJ
Copy link
Contributor

JJ commented May 10, 2020

$*REPO is now documented here, but the index still points to the definition in the glossary. We need either to change indexing, or to make one point to the other.

@JJ
Copy link
Contributor

JJ commented Dec 19, 2021

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type)
Projects
None yet
Development

No branches or pull requests

8 participants