Skip to content

Package documentation includes confusing symbol table lookups #969

@zostay

Description

@zostay

In the Packages language documentation, most of the examples given are incomplete, confusing, and some appear to just flat not work. If they work, I can't tell why they don't for me and some of the examples do not appear to be in roast anywhere that I can find.

It would be nice if all the examples shown actually work and it was clear what each symbolic dereference was referring to in an original. So provide a package definition like:

class Foo {
  class Bar {
    sub baz { }
    our $qux = 42;
  }
}

Then, write each of the examples in terms of a defined symbol so we know what the symbol lookup actually does.

For example, I found the sudden, unexplained use of $ to prefix symbolic dereferences in the first set of example to be confusing. The use of <::Bar> seems to be incorrect.

Anyway, I think the examples need to be reworked.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation issue (primary issue type)updatepart of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions