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

Spin off Per6::Type and Perl6::TypeGraph #2573

Closed
JJ opened this issue Jan 16, 2019 · 7 comments
Closed

Spin off Per6::Type and Perl6::TypeGraph #2573

JJ opened this issue Jan 16, 2019 · 7 comments
Labels
meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@JJ
Copy link
Contributor

JJ commented Jan 16, 2019

The problem

Perl6::Type is an ancillary class used here that has been essentially untouched for almost seven years (but for minor additions). It's not tested, or documented.

As a matter of fact, TypeGraph does most of the heavy lifting, with Perl6::Type having some methods, one of which is apparently just a private method.

Suggestions

Spin it off under the Perl 6 organization, and add tests and documentation. Possibly extricate the real stuff from TypeGraph and put it where it should be, in Perl6::Type.
Also check out whether those functions are not really done by something else in the ecosystem, or even in Rakudo itself.

@JJ JJ added the meta RFCs, general discussion, writing style, repository organization, etc. label Jan 16, 2019
@coke
Copy link
Collaborator

coke commented Mar 13, 2019

Adding the tests and documentation for this module can be done without moving it to a separate repository.

@JJ
Copy link
Contributor Author

JJ commented Mar 13, 2019 via email

@coke
Copy link
Collaborator

coke commented Mar 13, 2019

I'm not sure what the overhead is you're referring to. Adding a test under xt/, for example, adds no overhead to the CD pipeline.

The audience for the module is important when considering spinning it off. If we're using it solely to avoid duplication, for example, having it in a separate repository then increases the complexity of the setup required to use it and maintain it. As far as I can tell, it's not intended to be a general purpose module, but part of the tooling.

@JJ JJ changed the title Spin off Per6::Type Spin off Per6::Type and Perl6::TypeGraph May 30, 2019
@JJ
Copy link
Contributor Author

JJ commented May 30, 2019

Related: #2584
Spin them off as Perl6::Documentable::Type and Perl6::Documentable::Type::Graph

@JJ
Copy link
Contributor Author

JJ commented Jun 8, 2019

This is already published in the ecosystem. It's the turn of incorporating it to the repo.

@JJ JJ closed this as completed in bad9900 Jun 12, 2019
@JJ
Copy link
Contributor Author

JJ commented Jun 12, 2019

Tests are failing. We need to update also the dockerfiles to make this work. Also using this to solve this issue

@JJ
Copy link
Contributor Author

JJ commented Jun 12, 2019

OK, updated Dockerfiles and the tests are working now.

JJ added a commit that referenced this issue Jun 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

3 participants