Skip to content

Commit

Permalink
Various docs updates
Browse files Browse the repository at this point in the history
* "Github" -> "GitHub"
* strict=True only applies to marshmallow 2
* Add note about framework integration in CONTRIBUTING

#287 (comment)
  • Loading branch information
sloria committed Sep 18, 2018
1 parent 7acf60c commit 9318519
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 8 deletions.
23 changes: 18 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,30 @@ In General
In Particular
-------------

Questions, Feature Requests, Bug Reports, and Feedback. . .
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Questions, Feature Requests, Bug Reports, and Feedback
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

. . .should all be reported on the `Github Issue Tracker`_ .
should all be reported on the `GitHub Issue Tracker`_ .

.. _`Github Issue Tracker`: https://github.com/sloria/webargs/issues?state=open
.. _`GitHub Issue Tracker`: https://github.com/sloria/webargs/issues?state=open


Integration with a Another Web Framework…
+++++++++++++++++++++++++++++++++++++++++

…should be released as a separate package.

**Pull requests adding support for another framework will not be
accepted**. In order to keep webargs small and easy to maintain, we are
not currently adding support for more frameworks. Instead, release your
framework integration as a separate package and add it to the
`Ecosystem <https://github.com/sloria/webargs/wiki/Ecosystem>`_ page in
the `GitHub wiki <https://github.com/sloria/webargs/wiki/Ecosystem>`_ .

Setting Up for Local Development
++++++++++++++++++++++++++++++++

1. Fork webargs_ on Github. ::
1. Fork webargs_ on GitHub. ::

$ git clone https://github.com/sloria/webargs.git
$ cd webargs
Expand Down
4 changes: 2 additions & 2 deletions docs/_themes/lucuma/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ <h1 class="logo"><a href="{{ pathto('index') }}" title="{{ t.return_to_home_page
<a class="nav-item" href="{{ pathto('index') }}">{{ t.nav_home }}</a>
</li>
<li class="hidden-xs">
<a class="nav-item" href="{{ github }}" title="{{ github }}"><i class="fa fa-github"></i> Github</a>
<a class="nav-item" href="{{ github }}" title="{{ github }}"><i class="fa fa-github"></i> GitHub</a>
</li>
<li class="toc toc-large">
<a data-toggle="dropdown" href="#toc" class="nav-item">
<span class="visible-xs"><i class="fa fa-bars"></i></span>
</a>
</li>
</ul>
</header>
</header>
2 changes: 1 addition & 1 deletion docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ When you need more flexibility in defining input schemas, you can pass a marshma
# ...
.. warning::
You should always set ``strict=True`` (either as a ``class Meta`` option or in the Schema's constructor) when passing a schema to webargs. This will ensure that the parser's error handler is invoked when expected.
If you're using marshmallow 2, you should always set ``strict=True`` (either as a ``class Meta`` option or in the Schema's constructor) when passing a schema to webargs. This will ensure that the parser's error handler is invoked when expected.

.. warning::
Any `Schema <marshmallow.Schema>` passed to `use_kwargs <webargs.core.Parser.use_kwargs>` MUST deserialize to a dictionary of data. Keep this in mind when writing `post_load <marshmallow.decorators.post_load>` methods.
Expand Down

0 comments on commit 9318519

Please sign in to comment.