Skip to content

MAINT: Updates related to xref #292

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

Merged
merged 3 commits into from
Aug 5, 2020
Merged

MAINT: Updates related to xref #292

merged 3 commits into from
Aug 5, 2020

Conversation

rossbar
Copy link
Contributor

@rossbar rossbar commented Aug 5, 2020

A few updates related to xref

  • Use default alias mapping in make_xref test instead of custom one. From looking at git blame, it seems the original numpydoc_xref_aliases was replaced with DEFAULT_LINKS, but this change wasn't applied to the test suite. It's possible this was intentional, but I figured using the default dict made more sense.
  • Updated info about the numpydoc_xref_aliases config val in install.rst. The description says the default is an empty dict, but the default is actually DEFAULT_LINKS. The current description also makes it seem like the default depends on the intersphinx configuration though it doesn't seem to AFAICT.
  • Minor update to make_xref docstring

rossbar added 3 commits August 4, 2020 15:46
Switch to numpydoc's default link mapping for test_xref instead of
the custom (less comprehensive) link mapping.
Default aliases are not an empty dict, nor are they dependent
on intersphinx.
@codecov-commenter
Copy link

Codecov Report

Merging #292 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #292   +/-   ##
=======================================
  Coverage   93.10%   93.10%           
=======================================
  Files           7        7           
  Lines        1261     1261           
=======================================
  Hits         1174     1174           
  Misses         87       87           

@larsoner larsoner merged commit 7bee33a into numpy:master Aug 5, 2020
@larsoner
Copy link
Collaborator

larsoner commented Aug 5, 2020

Thanks @rossbar

@jarrodmillman jarrodmillman added this to the 1.2.0 milestone Jan 9, 2022
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.

4 participants