Skip to content

Add section label to contributing page index.rst #2301

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 1 commit into from
Nov 25, 2024

Conversation

RDaxini
Copy link
Member

@RDaxini RDaxini commented Nov 21, 2024

  • Closes #xxxx
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

Quick fix: Link to the contributing section on the package overview section led to the contributing on the pandas webpage rather than our contributing section. Added a section label to the index of our contributing page to fix this.

@kandersolar kandersolar added this to the v0.11.2 milestone Nov 25, 2024
Copy link
Member

@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, looks like we accidentally lost that label in #2219.

I wonder if there is some way to disable intersphinx for everything except :py: references, so that cases like this would result in build log warnings instead of falling back to linking to another package's docs that happens to have a matching label. Perhaps something to look into if someone has the motivation.

@kandersolar kandersolar merged commit a05e0c4 into pvlib:main Nov 25, 2024
33 checks passed
@RDaxini RDaxini deleted the update_contributing branch November 25, 2024 16:12
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.

3 participants