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.

Sign up for GitHub

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

Jump to bottom

Document the CompUnit namespace, or at least the part of it that's spec #3043

Open
5 of 14 tasks
JJ opened this issue Oct 2, 2019 · 0 comments
Open
5 of 14 tasks

Document the CompUnit namespace, or at least the part of it that's spec #3043

JJ opened this issue Oct 2, 2019 · 0 comments
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section

Comments

@JJ
Copy link
Contributor

JJ commented Oct 2, 2019 •
edited
Loading

The problem

After #502 , some CompUnit:::: have been documented. There are still many to go. Classes and roles are mostly undocumented.

These are admittedly implementation dependent, but they have been used extensively in the ecosystem

Suggestions

Document these classes and roles, which are stable:

  • CompUnit
  • CompUnit::DependencySpecification
  • CompUnit::Handle
  • CompUnit::Loader
  • CompUnit::PrecompilationRepository
  • CompUnit::PrecompilationStore
  • CompUnit::PrecompilationId
  • CompUnit::PrecompilationDependency
  • CompUnit::PrecompilationUnit
  • CompUnit::Repository
  • CompUnit::RepositoryRegistry
  • Distribution
  • Distribution::Resource
  • Distribution::Resources
@JJ JJ added big Issue consisting of many subissues docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section labels Oct 2, 2019
@finanalyst finanalyst mentioned this issue Nov 7, 2019
Merged
@finanalyst finanalyst mentioned this issue Nov 24, 2019
Merged
@finanalyst finanalyst mentioned this issue Jan 20, 2020
Open
@JJ JJ changed the title Document the CompUnit namespace Document the CompUnit namespace, or at least the part of it that's spec Feb 29, 2020
@JJ JJ mentioned this issue Sep 12, 2020
Open
JJ added a commit that referenced this issue Sep 12, 2020
@JJ
Writes stub for Distribution::Resource
ccc959d 
Starting to address part of #3043 and #3629
JJ added a commit that referenced this issue Sep 12, 2020
@JJ
First attempt at Distribution::Resource
d23b8da 
This refs mainly #3629, although it also tries to adress #3043.
It is a functional description, rather than a syntactic description; as a matter of fact, it's probably not sensible to describe one by one all the "IO" look-alike methods it's got, but a high-level one.

Not even the introduction is ready, it needs some work:

* Adds usage of "libraries" in "is native"
* Using resources directly.
JJ added a commit that referenced this issue Sep 13, 2020
@JJ
Trying to clarify IO::Path vs. Distribution::Resource
5deccc6 
WIP for #3629, although it also tries to address #3043 and #3095
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JJ