Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

perform some path sanitization over the generated names #258

Merged
merged 2 commits into from
May 5, 2021

Conversation

compnerd
Copy link
Contributor

The current scheme for the file generation uses the function label,
which uses ':' as a parameter separator. However, this character is not
valid on all file systems. This results in partial content generation
on Windows. Add a sanitization step which replaces "invalid" characters
with _ instead. This does not impact the rendering, only the
filenames and the generated URL references between the pages. With
this, we can generate and link function documentation on Windows.

The current scheme for the file generation uses the function label,
which uses ':' as a parameter separator.  However, this character is not
valid on all file systems.  This results in partial content generation
on Windows.  Add a sanitization step which replaces "invalid" characters
with `_` instead.  This does not impact the rendering, only the
filenames and the generated URL references between the pages.  With
this, we can generate and link function documentation on Windows.
@mattt
Copy link
Contributor

mattt commented May 5, 2021

@compnerd Thanks for your patience on this. Once CI comes back ✅ , I'll merge this in.

@compnerd
Copy link
Contributor Author

compnerd commented May 5, 2021

@mattt - do I need to redo the patch or can you merge this (for the signing)?

@mattt mattt merged commit 9d85789 into SwiftDocOrg:master May 5, 2021
@mattt
Copy link
Contributor

mattt commented May 5, 2021

@compnerd Sorry for the delay. This is now merged in.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants