Skip to content

Description of 'Pod::Defn' is misleading #4603

@tbrowder

Description

@tbrowder

The current docs read:

class Pod::Defn

Pod definition list

It is defined as

class Pod::Defn is Pod::Block

and has a method 'term'. It has no connection with a Pod list.

I suggest, in lieu of 'Pod definition list', use something like:

Holds a term and its definition

As a Pod::Block, the definition is carried in its 'text'attribute and it may be formatted. Its term 'method' text may also be formatted. One may also add 'config' keys and values for special needs. If the term has more than one word, be careful how you format your pod entry so the term's multiple words don't get incorporated into into its definition.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions