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

Allow specifying substitution characters #39

Open
sean-parent opened this issue Aug 7, 2019 · 1 comment
Open

Allow specifying substitution characters #39

sean-parent opened this issue Aug 7, 2019 · 1 comment
Assignees

Comments

@sean-parent
Copy link
Contributor

Currently the docs for a file like <lib/file.hpp> turns into a URL like lib2Ffile.hpp - it would be great to either allow lib-file.hpp or lib/file.hpp - similarly other special characters should be substituable to something more readable.

@fosterbrereton
Copy link
Contributor

Finding the right substitution characters can be tricky, and many options result in documentation collisions. For example, I tried - at one point, but then documentation for, say, operator- and operator* will end up resolving to the same thing. I only arrived at the current solution after many collision failures. I agree what's there now is not ideal, and am open to better solutions.

@fosterbrereton fosterbrereton self-assigned this Aug 7, 2019
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

No branches or pull requests

2 participants