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

Include example URLs in documentation #4

Closed
nichtich opened this issue Feb 13, 2015 · 0 comments
Closed

Include example URLs in documentation #4

nichtich opened this issue Feb 13, 2015 · 0 comments

Comments

@nichtich
Copy link
Owner

The DESCRIPTION should also include example URLs, as given in SYNOPSIS:

  • HTTP GET/POST format parameter
    e.g. format is set to xml for http://example.org/foo?format=xml if format xml has been defined.
  • URL path extension
    e.g. format is set to xml for http://example.org/foo.xml if format xml has been defined.
  • HTTP Accept Header
    e.g. format is set to xml if format xml has been defined with content type application/xml for Accept header value "application/xml"
cakirke added a commit to cakirke/Plack-Middleware-Negotiate that referenced this issue Feb 15, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant