🌐 AI搜索 & 代理 主页
Skip to content

Conversation

@Khushikela29
Copy link
Contributor

@Khushikela29 Khushikela29 commented Jan 12, 2025

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 github-actions bot added Documentation: examples files in galleries/examples Documentation: devdocs files in doc/devel labels Jan 12, 2025
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

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.

@timhoffm timhoffm changed the title Fixes #29305 Fix dead links in dev workflow docs Jan 12, 2025
@timhoffm
Copy link
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
Copy link
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
Copy link
Member

rcomer commented Jan 12, 2025

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

@Khushikela29
Copy link
Contributor Author

Thankyou @rcomer for the help :)

@rcomer
Copy link
Member

rcomer commented Jan 12, 2025

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
Copy link
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.

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

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

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.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay I'll fix it

- Removed unnecessary sentence in the development workflow.
- Fixed broken link in `development_workflow.rst`.
@timhoffm timhoffm merged commit 2f51249 into matplotlib:main Jan 13, 2025
22 checks passed
@QuLogic QuLogic added this to the v3.11.0 milestone Jan 13, 2025
@QuLogic QuLogic mentioned this pull request Jan 15, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc]: Dead link in dev workflow docs

5 participants