Skip to content
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

Clarify documentation about special case shields #432

Merged
merged 3 commits into from
Jun 19, 2022
Merged

Conversation

claysmalley
Copy link
Member

@claysmalley claysmalley commented Jun 18, 2022

Removes a line of documentation describing "special code" that does not exist.

Stacked refs in Italian motorways are a thing, but the current implementation displays the ref=* verbatim on one line (#366).

@claysmalley claysmalley added the documentation Improvements or additions to documentation label Jun 18, 2022
@claysmalley claysmalley changed the title Remove documentation about feature not implemented Remove documentation about stacked ref feature not implemented Jun 18, 2022
@zekefarwell
Copy link
Collaborator

I don't think the intent with this chunk of text was to imply that the Italian branch motorway refs were currently supported, but just to document them as a special case that would require special handling. Perhaps rather than "This requires special code ...", better phrasing would be "These are currently not supported. Potential future support will require special code ...". Another alternative to simply removing this from the documenation would be splitting the Special Cases list into two lists: Supported and Not Supported.

@claysmalley
Copy link
Member Author

Rearranged the special cases section and added the Italy example back in, with clarification that it is not implemented yet.

@claysmalley claysmalley changed the title Remove documentation about stacked ref feature not implemented Clarify documentation about special case shields Jun 18, 2022
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@ZeLonewolf ZeLonewolf left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@ZeLonewolf ZeLonewolf merged commit bab93b9 into main Jun 19, 2022
@ZeLonewolf ZeLonewolf deleted the clay-patch-2 branch June 19, 2022 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants