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

Do not make Immutable matrices the target of :mod:sympy links #19430

Merged
merged 2 commits into from May 26, 2020

Conversation

eric-wieser
Copy link
Member

@eric-wieser eric-wieser commented May 26, 2020

.. module:: sympy means "this page is the main documentation for sympy, and resolve refs relative to sympy".
.. currentmodule:: sympy means "resolve refs relative to sympy".

As written, this caused nonsensical intersphinx links when :mod:`sympy` was used.

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

  • other
    • intersphinx links to :mod:`sympy` no longer point to the documentation for Immutable Matrices

`.. module:: sympy` means "this page is the main documentation for `sympy`, and resolve refs relative to `sympy`".
`.. currentmodule:: sympy` means "resolve refs relative to `sympy`".

As written, this caused nonsensical intersphinx links when `` :mod:`sympy` `` was used.
@sympy-bot
Copy link

sympy-bot commented May 26, 2020

Hi, I am the SymPy bot (v158). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

  • other
    • intersphinx links to :mod:`sympy` no longer point to the documentation for Immutable Matrices (#19430 by @eric-wieser)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.7.

Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it.

Click here to see the pull request description that was parsed.

`.. module:: sympy` means "this page is the main documentation for `sympy`, and resolve refs relative to `sympy`".
`.. currentmodule:: sympy` means "resolve refs relative to `sympy`".

As written, this caused nonsensical intersphinx links when `` :mod:`sympy` `` was used.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed


#### Other comments


#### Release Notes

<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. The bot will check your release notes
automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* other
  * intersphinx links to `` :mod:`sympy` `` no longer point to the documentation for Immutable Matrices
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

Without a destination, the docs fail to build.
@codecov
Copy link

codecov bot commented May 26, 2020

Codecov Report

Merging #19430 into master will decrease coverage by 0.023%.
The diff coverage is n/a.

@@              Coverage Diff              @@
##            master    #19430       +/-   ##
=============================================
- Coverage   75.651%   75.628%   -0.024%     
=============================================
  Files          652       652               
  Lines       169712    169712               
  Branches     40051     40051               
=============================================
- Hits        128390    128350       -40     
- Misses       35720     35751       +31     
- Partials      5602      5611        +9     

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants