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

Docs for Blob missing candidates in several methods #2694

Open
8 of 12 tasks
MasterDuke17 opened this issue Mar 23, 2019 · 5 comments
Open
8 of 12 tasks

Docs for Blob missing candidates in several methods #2694

MasterDuke17 opened this issue Mar 23, 2019 · 5 comments
Labels
docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

Comments

@MasterDuke17
Copy link
Contributor

MasterDuke17 commented Mar 23, 2019 •
edited by JJ

Only method new(*@codes) is documented, but there are several others. See https://github.com/rakudo/rakudo/blob/master/src/core/Buf.pm6#L44-L56
While revising, some other are also missing. I list them here.

  • new
  • allocate
  • elems
  • decode
  • method chars(Blob:D:)
  • multi method Str(Blob:D:)
  • multi method Stringy(Blob:D:)
  • multi method list
  • method subbuf-end
  • method subbuf-length
  • Arity-1 &infix:<~> (refs Checklist for 6.d #2632 )
  • contents
@JJ JJ added docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. labels Mar 23, 2019
@JJ
Copy link
Contributor

JJ commented Mar 23, 2019

Thanks. We'll try to add them.

@JJ JJ changed the title Docs for Blob missing some of the .new candidates Docs for Blob missing candidates in several methods Mar 26, 2019
JJ added a commit that referenced this issue Mar 26, 2019
@JJ
Documenting all the .new cantidates for Blob refs #2694
8c8c8d6
JJ added a commit that referenced this issue Mar 26, 2019
@JJ
Expands allocate refs #2694
a87cda0
JJ added a commit that referenced this issue Mar 26, 2019
@JJ
Changes a few (non defined) return types
3911622 
Also adds definition for elems, refs #2694
JJ added a commit that referenced this issue Mar 26, 2019
@JJ
Added (undocumented) blob.decode methods refs #2694
49c6dc0
JJ added a commit that referenced this issue Apr 7, 2019
@JJ
Revises Buf for #2709, minor changes
ccb25ad 
Also adds missing methods for Blob. Refs #2694.
JJ added a commit that referenced this issue Apr 9, 2019
@JJ
Adds list refs #2694
7dc04c9
@Xliff
Copy link
Collaborator

Xliff commented May 4, 2019

Seeing as this is not closed, what else needs to be done to complete this task?

@JJ
Copy link
Contributor

JJ commented May 5, 2019

The last 4 points have not been added yet.

@zopsicle
Copy link
Contributor

zopsicle commented Jul 6, 2019 •
edited

infix:<eq> (and friends) seems to be overloaded for Blob but I can't find documentation for it. Should we add it to the list too?

https://github.com/rakudo/rakudo/blob/cf6f6d926f271c377f35666f1fbbd06ae797753a/src/core/Buf.pm6#L1128-L1130

@JJ
Copy link
Contributor

JJ commented Jul 6, 2019

@chloekek yes, please! Good catch.

JJ added a commit that referenced this issue Apr 1, 2021
@JJ
Adding candidates for subbuf
115fcfb 
Trying to address #3744, but actually addressing #2694, which didn't list specifically subbuf.

As a matter of fact, now these candidates do not have any example.
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) 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
4 participants
@JJ @Xliff @MasterDuke17 @zopsicle