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

Reconsider use of 'prime' placeholder variables in code fragments #2775

Closed
Eelis opened this issue Mar 13, 2019 · 3 comments
Closed

Reconsider use of 'prime' placeholder variables in code fragments #2775

Eelis opened this issue Mar 13, 2019 · 3 comments

Comments

@Eelis
Copy link
Contributor

Eelis commented Mar 13, 2019

For example:

or $\tcode{P}'\tcode{[N]}$

That 'prime' quote character is awfully close to a regular single quote character. Is there enough value in the 'prime' naming convention for placeholder variables that the possible confusion with regular C++ quote characters is worth it? :)

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 13, 2019

Hm, it looks pretty distinct to me in the rendered output. Primed vs unprimed symbols is a pretty common style for situations like this, so I quite like the way it is... how big a problem is this for you? How many people have been confused by this?

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 13, 2019
@Eelis
Copy link
Contributor Author

Eelis commented Mar 14, 2019

Primed symbols is certainly a common convention for math, but I think we're in an untypical situation, because we're mixing C++ syntax and math syntax. Given that C++ syntax is famously complex, I figured that a style guideline like the following would be uncontroversial:

Mix C++ syntax and math syntax in code fragments only when absolutely necessary.

But if not, that's ok too. It's not causing me any problems. :)

@tkoeppe
Copy link
Contributor

tkoeppe commented Mar 14, 2019

But overload resolution is a uniquely mathsy section of the specification already -- I think the notation is appropriate in its context. Shout if this really upsets anyone, but let's keep it as is otherwise.

@tkoeppe tkoeppe closed this as completed Mar 14, 2019
@tkoeppe tkoeppe removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Mar 14, 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

3 participants