Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
> > what their default context is
> There's no default context.

with a little more tolerance in interpretation of "context":

IIRC some operands and builtins only work in special contexts, some even throw (threw?) warnings if not used properly.

> > There ought to be a repository of common expressions and how they behave in each context
> The perl documentation does that, doesn't it?

Well I once meditated over this, unfortunately POD doesn't have a standard notation for a brief definition for the interface of a term.

If it had, they could not only automatically be compiled into cheat sheets, but also into tool tips for IDEs or grammatical rules for syntax checkers.

There are various alternative sources for such abstracts, which get hopelessly fast outdated

For instance emacs's cperl-mode has tool-tips hardcoded which are far from being up-to-date.

Another advantage of such an hypothetical POD-extension could be the definition of use cases for snippet-expansion within an IDE, like for yasnippet in emacs or more detailed error-texts for diagnostics.

Of course some (all?) of this could be achieved with a special =FOR :format-paragraph, but there is no standard notation yet. (maybe Perl6 signatures could be a good start)

Cheers Rolf


In reply to Re^2: Easy Reference for Contexts (POD-Extension) by LanX
in thread Easy Reference for Contexts by cat_baby

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (7)
As of 2024-04-18 09:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found