Skip to content

chore: make documented URLs optional#591

Merged
43081j merged 1 commit intomainfrom
documented-urls-optional
Apr 14, 2026
Merged

chore: make documented URLs optional#591
43081j merged 1 commit intomainfrom
documented-urls-optional

Conversation

@43081j
Copy link
Copy Markdown
Contributor

@43081j 43081j commented Apr 13, 2026

🔗 Linked issue

N/A

📚 Description

This makes documented replacements have an optional URL rather than it
being required. Most or all documented replacements are part of a
mapping which itself has the unified documentation (of all replacements
for that mapping). So we don't really need to repeat the same URL per
replacement.

This makes documented replacements have an optional URL rather than it
being required. Most or all documented replacements are part of a
mapping which itself has the unified documentation (of all replacements
for that mapping). So we don't really need to repeat the same URL per
replacement.
@43081j
Copy link
Copy Markdown
Contributor Author

43081j commented Apr 13, 2026

@ghostdevv @gameroman thoughts on this?

Copy link
Copy Markdown
Collaborator

@ghostdevv ghostdevv left a comment

Choose a reason for hiding this comment

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

Sounds good - we should really make some linting rules for the replacements, one of which could make sure that either the replacement or mapping has docs when relevant

Copy link
Copy Markdown
Contributor

@gameroman gameroman left a comment

Choose a reason for hiding this comment

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

This makes sense 👍

@43081j
Copy link
Copy Markdown
Contributor Author

43081j commented Apr 14, 2026

Sounds good - we should really make some linting rules for the replacements, one of which could make sure that either the replacement or mapping has docs when relevant

this is a good idea 👍

we do already have some rules, and roman added a few recently. so would be good to add this one too

@43081j 43081j merged commit 63cf8fd into main Apr 14, 2026
4 checks passed
@43081j 43081j deleted the documented-urls-optional branch April 14, 2026 11:54
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.

3 participants