Skip to content

Documentation suggestions #811

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.

Sign up for GitHub

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

Open
Chris-May wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Documentation suggestions #811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf6987c
Adding a missing quote
Chris-May Oct 14, 2021
c598281
Contributing.rst: Grammar correction and jump link addition
Chris-May Oct 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Contributing

flask-restplus is open-source and very open to contributions.

If you're part of a corporation with an NDA, and you may require updating the license.
See Updating Copyright below
If you're part of a corporation with an NDA, you may require updating the license.
See :ref:`Updating Copyright` below

Submitting issues
-----------------
Expand Down Expand Up @@ -107,6 +107,8 @@ NOTE: You'll need `NPM <https://docs.npmjs.com/getting-started/>`_ installed to
If you're new to NPM, also check out `nvm <https://github.com/creationix/nvm/blob/master/README.md>`_


.. _Updating Copyright:

Updating Copyright
------------------

Expand Down
2 changes: 1 addition & 1 deletion flask_restplus/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class Api(object):
:param str contact: A contact email for the API (used in Swagger documentation)
:param str license: The license associated to the API (used in Swagger documentation)
:param str license_url: The license page URL (used in Swagger documentation)
:param str endpoint: The API base endpoint (default to 'api).
:param str endpoint: The API base endpoint (default to 'api').
:param str default: The default namespace base name (default to 'default')
:param str default_label: The default namespace label (used in Swagger documentation)
:param str default_mediatype: The default media type to return
Expand Down