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

Upstream edge cases. #129

Open
Carreau opened this issue Apr 6, 2022 · 0 comments
Open

Upstream edge cases. #129

Carreau opened this issue Apr 6, 2022 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Carreau
Copy link
Member

Carreau commented Apr 6, 2022

List list a number of edge cases in upstream libraries,
it would be great is upstream would accept to fix them.

They are usually handled by sphinx but add complexity to papyri.

Numpy:

Links that use `<...>` syntax with no text. I think they can be replaced by just `...`

$ rg '[^`]`<.+>`'
doc/RELEASE_WALKTHROUGH.rst.txt
158:provided at `<https://github.com/MacPython/numpy-wheels>`_ to check the
245:Go to `<https://github.com/numpy/numpy/releases>`_, there should be a ``v1.21.0
311:This assumes that you have forked `<https://github.com/numpy/numpy.org>`_::

numpy/_typing/_scalars.py
11:# coerced into `<X>` (with the casting rule `same_kind`)

doc/HOWTO_RELEASE.rst.txt
112:- numpy-wheels `<https://github.com/MacPython/numpy-wheels>`_ (clone)
128:- terryfy `<https://github.com/MacPython/terryfy>`_ (clone).

doc/source/release/1.5.0-notes.rst
19:at `<https://web.archive.org/web/20100817112505/http://bitbucket.org/jpellerin/nose3/>`_ however.

Scipy

Math directive, some function use multiline math directive where it's difficult to distinguish arguments from body:

The Bartlett window is defined as

.. math:: w(n) = \frac{2}{M-1} \left(
          \frac{M-1}{2} - \left|n - \frac{M-1}{2}\right|
          \right)

would be better as

The Bartlett window is defined as

.. math::

   w(n) = \frac{2}{M-1} \left(
          \frac{M-1}{2} - \left|n - \frac{M-1}{2}\right|
          \right)

Here is some functions that do that:

 scipy.signal.bartlett
 scipy.signal.chebwin
 scipy.signal.chebwin
 scipy.signal.hamming
 scipy.signal.hann
 scipy.signal.kaiser
 scipy.signal.windows._windows.bartlett
 scipy.signal.windows._windows.chebwin
 scipy.signal.windows._windows.chebwin
 scipy.signal.windows._windows.general_cosine
 scipy.signal.windows._windows.general_hamming
 scipy.signal.windows._windows.hamming
 scipy.signal.windows._windows.hann
 scipy.signal.windows._windows.kaiser
@Carreau Carreau added help wanted Extra attention is needed good first issue Good for newcomers labels Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant