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

DOC: Fix reference warning for buffer. #24331

Merged
merged 1 commit into from
Aug 4, 2023
Merged

Conversation

liang3zy22
Copy link
Contributor

Fix following warning:

arrays.dtypes.rst:187: WARNING: py:class reference target not found: buffer
arrays.interface.rst:181: WARNING: py:class reference target not found: buffer
arrays.ndarray.rst:24: WARNING: py:class reference target not found: buffer

I searched to find that buffer is replaced by memoryview. So I used memoryview class reference.

@mattip mattip merged commit 4359c87 into numpy:main Aug 4, 2023
53 of 54 checks passed
@mattip
Copy link
Member

mattip commented Aug 4, 2023

Thanks @liang3zy22

@mattip
Copy link
Member

mattip commented Aug 4, 2023

I used this one-liner on the build log to find the sources of the 159 remaining warnings

grep "reference target not found" build.log | sed -e "s/reference target not found/z/" | cut -f2- -dz | sort | uniq -c | sort -n

Here are the references with more than one error. It would be nice to solve the size one, I think that comes from a docstring for a function with a size parameter. Somehow that particular kwarg messes up sphinx/numpydoc.

      2 : CCompiler
      2 : doc.indexing
      2 : index_exp
      2 : ndim
      2 : npy_datetime
      2 : PyArray_VectorUnaryFunc
      3 : FILE
      3 : formatter
      3 : numpy.core.defchararray
      3 : numpy.ma.core.MaskedArray
      3 : PyGenericArr_Type
      5 : ABCPolyBase
      6 : trimseq
      9 : size_t
     51 : size

@liang3zy22
Copy link
Contributor Author

@mattip , OK, let me do it.

@liang3zy22 liang3zy22 deleted the bufferrefwarn branch August 4, 2023 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants