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

Improve Documentation for format in Renderer #3387

Closed
cancan101 opened this issue Sep 10, 2015 · 1 comment
Closed

Improve Documentation for format in Renderer #3387

cancan101 opened this issue Sep 10, 2015 · 1 comment

Comments

@cancan101
Copy link
Contributor

  1. The docs show a confusing . as the prefix for the format. For example:

.format: '.html'

whereas the class has:

class TemplateHTMLRenderer(BaseRenderer):
...
    format = 'html'
  1. The docs don't give a suggestion as to what should format be set to when the media_type = 'image/*' or */*.
@tomchristie
Copy link
Member

  1. Sounds like it needs a docs pull request, yup.
  2. What change would you suggest here? Either you'll need a custom conneg class, in order to handle multiple possible format extenstions, or you could use something generic, eg .img

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

2 participants