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

(see #stuff) references break on trailing punctuation #730

Closed
kopischke opened this issue Jan 15, 2014 · 3 comments
Closed

(see #stuff) references break on trailing punctuation #730

kopischke opened this issue Jan 15, 2014 · 3 comments

Comments

@kopischke
Copy link

Using (see #stuff). instead of (see #stuff) (note the period in the first example) will break reference lookup.

@lsegal
Copy link
Owner

lsegal commented Jan 20, 2014

Periods are not supported with the (see X) syntax, so the current behaviour is expected.

@kopischke
Copy link
Author

I don’t doubt this is expected behavior – I posit it is orthogonal to user expectations :). Adding punctuation is a natural idea in a natural language input-ish setting, and as trailing punctuation has no greater significance than trailing whitespace, which is ignored when parsing for the reference token, I’d also expect it to be ignored. Anyway, I’ve already come out the other end of that particular tunnel, so consider it “that really tripped me up” input and feel free to close; personally, I’d rather see #728 and #729 fixed, which are really messing up my docs.

@lsegal
Copy link
Owner

lsegal commented Jan 20, 2014

The issue is that (see X) is special macro syntax, and not natural language. It's meant to be unambiguous. Otherwise it would be impossible to differentiate actual natural language inputs from this macro reference syntax.

I am going to close this. And yes, I have seen the other reports.

@lsegal lsegal closed this as completed Jan 20, 2014
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