Skip to content

Commit

Permalink
Merge pull request numpy#13170 from mattip/doc-warnings-to-error
Browse files Browse the repository at this point in the history
DOC, BUILD: fail the devdoc build if there are warnings
  • Loading branch information
rgommers authored Mar 21, 2019
2 parents c8cd7b7 + d301712 commit 0eda21b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
6 changes: 1 addition & 5 deletions doc/DISTUTILS.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -319,11 +319,7 @@ and :c:data:`/**end repeat**/` lines, which may also be nested using
consecutively numbered delimiting lines such as :c:data:`/**begin repeat1`
and :c:data:`/**end repeat1**/`. String replacement specifications are started
and terminated using :c:data:`#`. This may be clearer in the following
template source example:

.. code-block:: C
:linenos:
:emphasize-lines: 3, 13, 29, 31
template source example::

/* TIMEDELTA to non-float types */

Expand Down
3 changes: 2 additions & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ FILES=
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
ALLSPHINXOPTS = -WT --keep-going -d build/doctrees $(PAPEROPT_$(PAPER)) \
$(SPHINXOPTS) source

.PHONY: help clean html web pickle htmlhelp latex changes linkcheck \
dist dist-build gitwash-update
Expand Down
10 changes: 5 additions & 5 deletions doc/release/1.17.0-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ New functions
Deprecations
============

``np.polynomial`` functions warn when passed ``float``s in place of ``int``s
----------------------------------------------------------------------------
Previously functions in this module would accept ``float``s provided their
values were integral. For consistency with the rest of numpy, doing so is now
deprecated, and in future will raise a ``TypeError``.
``np.polynomial`` functions warn when passed ``float`` in place of ``int``
--------------------------------------------------------------------------
Previously functions in this module would accept ``float`` values provided they
were integral (``1.0``, ``2.0``, etc). For consistency with the rest of numpy,
doing so is now deprecated, and in future will raise a ``TypeError``.

Similarly, passing a float like ``0.5`` in place of an integer will now raise a
``TypeError`` instead of the previous ``ValueError``.
Expand Down

0 comments on commit 0eda21b

Please sign in to comment.