The Wayback Machine - https://web.archive.org/web/20201102213959/https://github.com/encode/django-rest-framework/issues/7350
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

Docs are based on master and not latest released version #7350

Closed
krukas opened this issue May 27, 2020 · 2 comments
Closed

Docs are based on master and not latest released version #7350

krukas opened this issue May 27, 2020 · 2 comments

Comments

@krukas
Copy link

@krukas krukas commented May 27, 2020

Checklist

  • I have verified that that issue exists against the master branch of Django REST framework.
  • I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • This is not a usage question. (Those should be directed to the discussion group instead.)
  • This cannot be dealt with as a third party library. (We prefer new functionality to be in the form of third party libraries where possible.)
  • I have reduced the issue to the simplest possible case.
  • I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)

Issue was made for latest release (3.11.0)

Steps to reproduce

Read the documentation about Schemas and want to use the tags described in the documentation.

AutoSchema(tags=['tag1', 'tag2'])

Expected behavior

For the described documentation to work. I checked the code if the documentation is not outdated. The documentation is not outdated, but it looks like it uses the latest version from master:

Docs
Master: https://github.com/encode/django-rest-framework/blob/master/docs/api-guide/schemas.md#grouping-operations-with-tags
3.11.0: https://github.com/encode/django-rest-framework/blob/3.11.0/docs/api-guide/schemas.md

Code
Master: https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/openapi.py#L121
3.11.0: https://github.com/encode/django-rest-framework/blob/3.11.0/rest_framework/schemas/openapi.py#L79

Actual behavior

Get error message: TypeError: __init__() got an unexpected keyword argument 'tags'

Solutions

Best solution would be to have the ability to switch version of the docs you want to see and default to latest stable release.

I think the easiest solution is to have master only have stable released version and separate branch for development. Or create a stable branch that has the latest release version and use documentation generation based on stable branch.

@tomchristie
Copy link
Member

@tomchristie tomchristie commented Jun 2, 2020

Latest docs are built from 3.11.

@tomchristie tomchristie closed this Jun 2, 2020
@tomchristie
Copy link
Member

@tomchristie tomchristie commented Jun 2, 2020

Thanks for having reported this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can’t perform that action at this time.