Skip to content

docs: fix four links to test files that moved in 2021 - #1133

Open
melbinjp wants to merge 4 commits into
sendgrid:mainfrom
melbinjp:docs/test-paths-moved-in-2021
Open

docs: fix four links to test files that moved in 2021#1133
melbinjp wants to merge 4 commits into
sendgrid:mainfrom
melbinjp:docs/test-paths-moved-in-2021

Conversation

@melbinjp

@melbinjp melbinjp commented Aug 21, 2026

Copy link
Copy Markdown

Four links in the docs point at test files that moved in 1dcc378 (2021-12-14, "test: split up unit and integ tests"). Nothing else is touched.

file link now
CONTRIBUTING.md:76 test/test_sendgrid.py test/unit/test_sendgrid.py
TROUBLESHOOTING.md:127 test/test_eventwebhook.py test/unit/test_eventwebhook.py
sendgrid/helpers/inbound/README.md:130 test/test_config.py test/unit/test_config.py
sendgrid/helpers/inbound/README.md:131 test/test_parse.py test/unit/test_parse.py

Three of those are plain renames. The CONTRIBUTING.md one is not, so here is the reasoning in full.

1dcc378 moved the original file to test/integ/test_sendgrid.py (R100, content unchanged), and it is the only test_sendgrid.py that commit touched. A second one appeared later at test/unit/test_sendgrid.py, added by b5afcca (2023-11-24) with the GDPR region work, and it holds unit tests of the client host. The CONTRIBUTING sentence asks the reader to add unit tests, so it points there rather than at the file git paired the rename with. Say the word if you would rather it named both.

CONTRIBUTING.md is the file a first-time contributor is told to read, and its link to the test they are asked to edit has been a 404 for a little under five years.

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.

1 participant