Markup is a bit busted right now - Githubissues

executors / futures

A proposal for a futures programming model for ISO C++

22 stars 7 forks source link

Markup is a bit busted right now #104

Closed RedBeard0531 closed 6 years ago

RedBeard0531 commented 6 years ago

A few examples I noticed while trying to read the rendered version:

[ ] The first line of the intro looks like the *'s are not causing italics, presumably due to the embedded link
[ ] double * in FAQ
[ ] # marks in 2.1. Future/Promise Model
[ ] this sentence is unfinished and blends with the next line
[ ] "called by the calling thread" cancelling thread?
[ ] this line isn't getting an extra layer of nesting. Also, not markup related, but that sentence can't possibly be right. Why would fulfilling the promise make a unique future invalid?

I'll edit this to add more as I read.

LeeHowes commented 6 years ago

1 is fixed in https://github.com/executors/futures/pull/99 which someone can approve and merge if they like :)

griwes commented 6 years ago

I think the comment about the sentence not being right is right: I think it misses "the promise becomes invalid" or something like that. I'll try to spec that correctly.

griwes commented 6 years ago

What is the unfinished sentence trying to say? I'm tempted to just strike that note.

griwes commented 6 years ago

Oh nvm. Found it.

griwes commented 6 years ago

I think the "calling thread" is correct there, but "cancelling thread" would mean the same thing and possibly be less confusing. I'm tempted to say "let's leave this to LWG".

griwes commented 6 years ago

Actually what I suggested for the sentence about fullfilment would be redundant, since that's specified by the Promise concept already.

griwes commented 6 years ago

I can solve these, but it kinda makes little sense for me to submit a PR until the other two are merged.