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

p6doc mentions Type::* in instructions / LTA errors on unknown types #1224

Closed
zoffixznet opened this issue Feb 27, 2017 · 2 comments
Closed

Comments

@zoffixznet
Copy link
Contributor

This is a three-part issue:

  1. The instructions of p6doc prepend Type:: to type names and that makes users think the Type:: is a necessary prefix

  2. If the user looks up a non-existant type, the message is somewhat LTA. I'd expect it to catch the failed use and tell me there's no such type:

zoffix@VirtualBox:~$ p6doc -f Blarg.push                                                                                                                                                                                                                       
Could not find Blarg at line 0 in:
    /home/zoffix/.perl6
    /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/site
    /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/vendor
    /home/zoffix/.rakudobrew/moar-nom/install/share/perl6
    CompUnit::Repository::AbsolutePath<68834912>
    CompUnit::Repository::NQP<68268368>
    CompUnit::Repository::Perl5<68268408>
  in sub locate-curli-module at /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/site/resources/C3A18C4AD5209A1B226E53B2C22A5347E5AC4790 line 219
  in sub locate-module at /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/site/resources/C3A18C4AD5209A1B226E53B2C22A5347E5AC4790 line 39
  in sub MAIN at /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/site/resources/C3A18C4AD5209A1B226E53B2C22A5347E5AC4790 line 128
  in block <unit> at /home/zoffix/.rakudobrew/moar-nom/install/share/perl6/site/resources/C3A18C4AD5209A1B226E53B2C22A5347E5AC4790 line 226
  1. If the user looks up an existent routine but on the wrong type, the utility displays a misleading error:
    ``
    `p6doc -f Str.push

"No documentation found for method 'push'"

@coke coke added the build label Mar 6, 2017
@coke
Copy link
Collaborator

coke commented Mar 6, 2017

(build not quite right, but closest we have)

stmuk added a commit that referenced this issue Sep 1, 2017
@stmuk
Copy link
Contributor

stmuk commented Sep 1, 2017

All three issues should be addressed as of f75c499

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants