FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix dead links in dev workflow docs by Khushikela29 · Pull Request #29463 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Fix dead links in dev workflow docs - #29463

Merged
timhoffm merged 2 commits into
matplotlib:mainfrom
Khushikela29:main
Jan 13, 2025
ConversationCommits (2)ChecksFiles changed
Merged

Fix dead links in dev workflow docs#29463
timhoffm merged 2 commits into
matplotlib:mainfrom
Khushikela29:main

Conversation

Khushikela29 commented Jan 12, 2025 •
edited by timhoffm
Loading

Copy link
Copy Markdown
Contributor

PR summary

  • This pull request addresses the removal of a broken link in the doc/devel/development_workflow.rst and updates the content to improve clarity and accuracy.
  • The original link to why-the-flag? was broken, and the resources are no longer available.
  • Resolving the issue by replacing "For more information, see why the -a flag? and the git commit manual page." to "For more information, see the git commit manual page."

Closes #29305.

PR checklist

github-actions Bot added Documentation: examples files in galleries/examples Documentation: devdocs files in doc/devel labels Jan 12, 2025
timhoffm reviewed Jan 12, 2025
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

You seem to also have the commits from #29433 in this PR. While they are identical, the marge would go through, but please rebase so that it's clear these commits don't have anything to do with this PR.

Comment thread doc/devel/development_workflow.rst Outdated
timhoffm changed the title Fixes #29305 Fix dead links in dev workflow docs Jan 12, 2025

timhoffm commented Jan 12, 2025

Copy link
Copy Markdown
Member

On a side-note, please don't name PRs like Fixes #29305. This is not easily understandable. Instead, use a semantic title like "Fix dead links in dev workflow docs". You should then add "Closes #29305" to the description. See also our Pull request guide. - I've adjusted this PR to conform with these rules.

Khushikela29 commented Jan 12, 2025

Copy link
Copy Markdown
Contributor Author

I've tried to resolve the issue, but I guess the checks still didn't pass. I am open to all your suggestions, please guide me where I am doing things wrong since I am in my learning process :)

rcomer commented Jan 12, 2025

Copy link
Copy Markdown
Member

To fix the PR cleanliness check, you can squash the commits into one with an interactive rebase.

Khushikela29 commented Jan 12, 2025

Copy link
Copy Markdown
Contributor Author

Thankyou @rcomer for the help :)

rcomer commented Jan 12, 2025

Copy link
Copy Markdown
Member

I think you can also use interactive rebase to drop the "attach_note" commit.

For future PRs, you should create a separate feature branch, and then you don't get this problem.

Khushikela29 commented Jan 12, 2025

Copy link
Copy Markdown
Contributor Author

Sure @rcomer I'll keep that in mind.
I am interested in contributing more to the project, it seems fascinating.. if you can help or guide me with more issues in any possible way I'd be grateful.

story645 reviewed Jan 13, 2025
View reviewed changes

story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Don't accept my review w/o first dropping the unrelated commit, but the article the is missing

Comment thread doc/devel/development_workflow.rst Outdated
file that has been modified, except files listed in ``.gitignore``. For more
information, see `why the -a flag?`_ and the
`git commit <https://git-scm.com/docs/git-commit>`_ manual page.
information, see `git commit <https://git-scm.com/docs/git-commit>`_ manual page.

story645 Jan 13, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
information, see `git commit <https://git-scm.com/docs/git-commit>`_ manual page.
information, see the `git commit <https://git-scm.com/docs/git-commit>`_ manual page.

Khushikela29 Jan 13, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

okay I'll fix it

Fixed broken link
bc68ad1 
- Removed unnecessary sentence in the development workflow.
- Fixed broken link in `development_workflow.rst`.
timhoffm merged commit 2f51249 into matplotlib:main Jan 13, 2025
QuLogic added this to the v3.11.0 milestone Jan 13, 2025
QuLogic mentioned this pull request Jan 15, 2025
Merged
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

story645 story645 left review comments
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation: devdocs files in doc/devel Documentation: examples files in galleries/examples

Projects

None yet

Milestone

v3.11.0

Development

Successfully merging this pull request may close these issues.

[Doc]: Dead link in dev workflow docs

5 participants

Back | FazBrowse Home | New Git URL