doc icon indicating copy to clipboard operation
doc copied to clipboard

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

Open AlexDaniel opened this issue 8 years ago • 15 comments

Code:

say WHAT $*REPO

Result:

(Installation)

AlexDaniel avatar May 08 '16 14:05 AlexDaniel

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

jonathanstowe avatar May 08 '16 14:05 jonathanstowe

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

JJ avatar Jan 27 '18 19:01 JJ

@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 avatar Apr 18 '18 16:04 JJ

$*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.

ugexe avatar Jun 30 '18 23:06 ugexe

And what would make sense?

JJ avatar Jul 01 '18 06:07 JJ

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.

ugexe avatar Jul 01 '18 13:07 ugexe

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.

niner avatar Jul 02 '18 14:07 niner

El lun., 2 jul. 2018 a las 16:16, niner ([email protected]) escribiĂł:

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.

I discovered them a short time ago. I did a PR on it yesterday, as a matter of fact. "Not documented" refers to this repo. We'll have to translate what's in there to here, which I'm in the process of doing.

JJ avatar Jul 02 '18 15:07 JJ

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

ohmycloud avatar Feb 20 '19 01:02 ohmycloud

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

lizmat avatar May 04 '19 13:05 lizmat

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

rafaelschipiura avatar May 05 '19 17:05 rafaelschipiura

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

JJ avatar May 06 '19 05:05 JJ

$*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 avatar May 10 '20 16:05 JJ

This issue on how to set RAKULIB to different types of repositories will help (mentioned in https://github.com/ugexe/zef/issues/430 by @ugexe )

JJ avatar Dec 19 '21 19:12 JJ