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 Perl6::Documentable #1937

Closed
JJ opened this issue Apr 17, 2018 · 2 comments
Closed

Spin off Perl6::Documentable #1937

JJ opened this issue Apr 17, 2018 · 2 comments
Assignees
Labels
meta RFCs, general discussion, writing style, repository organization, etc. wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@JJ
Copy link
Contributor

JJ commented Apr 17, 2018

The problem

This is one of the modules that are used in htmlify.p6 (see #1823), so far exclusively. It is barely documented, and it does not have a single test. Functionality seems clear, but it's not specified anywhere.
It does not have downstream dependencies, so it can be safely spun off and published as an independent module, which might have only perl6/doc as a paying customer, but then it's kinda a general module for processing and storing, in memory, documentation, so it might find its usefulness outside perl6/doc, when big modules with complicated documentation layout starts to sprout.
Anyway, isolating and clearly specifying its functionality through tests will help with a faster, safer and more efficient testing and building of the Perl6 documentation.

Suggestions

There's a (relatively simple) way of keeping file history, so I would create a new perl6/per6-doc-documentable repo and start working on that. When it's completed and published, I (or whoever) will publish it in p6c/ and either remove it from perl6/doc or keep it as a submodule.

I'm "assigning" this issue to a bunch of you to solicit some explicit feedback. A simple thumbs up or down will do. Just deassign yourself when you're done, or if you don't want to participate. Thanks!

@JJ JJ added JJ TPF Grant meta RFCs, general discussion, writing style, repository organization, etc. labels Apr 17, 2018
@zoffixznet zoffixznet removed their assignment Apr 17, 2018
@cfa cfa removed their assignment Apr 17, 2018
@tisonkun tisonkun removed their assignment Apr 17, 2018
@AlexDaniel AlexDaniel removed their assignment Apr 17, 2018
@coke
Copy link
Collaborator

coke commented Apr 17, 2018

I don't think pushing it to another repo will be helpful, esp. given its size, but documentation and tests are a plus. I will probably be touching parts of this on the coke/build branch.

@JJ
Copy link
Contributor Author

JJ commented Apr 17, 2018

Perl6::Documentable is just a couple of files. I'll check out that branch.

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. wishlist "nice to have" issues; might require a lot of work or a big change or be low priority
Projects
None yet
Development

No branches or pull requests

12 participants