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

Documentation for traits is lacking #1957

Open
Kaiepi opened this issue Apr 23, 2018 · 1 comment
Open

Documentation for traits is lacking #1957

Kaiepi opened this issue Apr 23, 2018 · 1 comment
Labels
docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

Comments

@Kaiepi
Copy link
Collaborator

Kaiepi commented Apr 23, 2018

The problem

  • There's already some documentation for what traits are under doc/Language/functions.pod6 but it's incomplete and doesn't explain how they can be used with Routine, Variable, Attribute, and types fully
  • The is repr trait is undocumented

Suggestions

  • Expanding the traits section in the functions would be really useful since I don't think even the Perl 6 blogs out there document them completely either
  • Creating a pod explaining what is repr does, why it works differently from the other traits, and documenting each type of REPR that's reasonable to use outside native code would also be useful
@JJ
Copy link
Contributor

JJ commented Apr 24, 2018

The second issue has been already commented in #1863 .
OTOH, maybe traits needs its very own page...

@JJ JJ added new part of "docs" - indicates that this documentation is for a new, currently undoc'd section and removed JJ TPF Grant labels May 14, 2018
@JJ JJ added update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. docs Documentation issue (primary issue type) big Issue consisting of many subissues labels May 27, 2018
JJ added a commit that referenced this issue Jun 8, 2018
@JJ
Starting a new page on traits
daadb38 
Which seems the best solution for both #1863 and #1957. It starts with
differentiating traits (the general concept, which includes roles) and
traits in Perl 6 (which mainly affects the representation).
JJ added a commit that referenced this issue Jun 8, 2018
@JJ
Adding some information and links for is repr values
e10e3e7 
Just an enumeration and links to the NativeCall where they are
explained more extensively. Refs #1863 and #1957
JJ added a commit to JJ/my-raku-examples that referenced this issue Jun 8, 2018
@JJ
Adds example for refs Raku/doc#1863, Raku/doc#1957
ee91b6b
JJ added a commit that referenced this issue Jun 8, 2018
@JJ
Adds reference to P6Opaque, refs #1863, #1957
c84fafe
JJ added a commit that referenced this issue Jun 8, 2018
@JJ
Adds uninstantiable with examples.
432c409 
This closes #1863. It advances #1957, but still some information on
how to use traits in varibles and attributes is going to be needed.
JJ added a commit to JJ/my-raku-examples that referenced this issue Jun 9, 2018
@JJ
Adds logger routine for Raku/doc#1957
fde629b
JJ added a commit that referenced this issue Jun 9, 2018
@JJ
Restructures the traits page
39fe1e4 
With a better definition given by @moritz Also restructures. Refs #1957
JJ added a commit that referenced this issue Jun 9, 2018
@JJ
Reorganizes and adds info on «is» for classes. Refs #1957
2cd9fd0
@JJ JJ mentioned this issue Apr 11, 2019
Open
This was referenced May 22, 2019
Closed
Open
@coke coke self-assigned this Nov 14, 2022
@coke coke removed the big Issue consisting of many subissues label Nov 14, 2022
@coke coke removed their assignment Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JJ @coke @Kaiepi