Mention " vs. ' syntax in help text

[nparlante]

Hey @cahrens -- as we discussed

I figure if we ever get around to making real user-syntax-error feedback, then we can shrink the help text, but for now it's better to just hang it out there.

[cahrens]

@mhoeber I am going to defer to you on this documentation question. Personally, I'd rather see double-quote and single-quote vs. the symbols, but I might just be old-fashioned. :)

[mhoeber]

@cahrens don't we have to use the symbols as to not close the string value? Or I'm missing something.

Aside from that, I think the a warning in the side bar would be more effective. The small gray text at the top doesn't stand out. I can create a task for myself for that.

[nparlante]

Hmm, I guess my thinking was that the " and ' are literally the
characters to type in right or wrong, so it was nice to be super direct
about it, although this has the cost of being more visually noisy vs.
using a series of words to describe the issue.

Anyway, I'm happy to go with whatever @mhoeber prefers, and we'll just
ship it.

Cheers,

Nick

Anyway
On 12/12/13 12:56 PM, Christina Roberts wrote:

@mhoeber https://github.com/mhoeber I am going to defer to you on
this documentation question. Personally, I'd rather see double-quote
and single-quote vs. the symbols, but I might just be old-fashioned. :)

—
Reply to this email directly or view it on GitHub
https://github.com/edx/edx-platform/pull/1939#issuecomment-30460883.

[cahrens]

Oh, I didn't actually notice where the text was. I assumed it was in the sidebar on the RHS.

[nparlante]

My gut is that the at-the-top position was good for this short but
important info for people typing in here.

Anyway, I've got the PR all lined up, so if there's a wording that's ok
we can just go with it and we're done.

Or if Mark wants to take it over as a task, that's ok with me.

On 12/12/13 1:13 PM, Mark Hoeber wrote:

@cahrens https://github.com/cahrens don't we have to use the symbols
as to not close the string value? Or I'm missing something.

Aside from that, I think the a warning in the side bar would be more
effective. The small gray text at the top doesn't stand out. I can
create a task for myself for that.

—
Reply to this email directly or view it on GitHub
https://github.com/edx/edx-platform/pull/1939#issuecomment-30462282.

[nparlante]

Yes, it modified the "JSON" explanation that was there at the top. I
suppose that's why I kept it so short .. not much room up there!

On 12/12/13 1:22 PM, Christina Roberts wrote:

Oh, I didn't actually notice where the text was. I assumed it was in
the sidebar on the RHS.

—
Reply to this email directly or view it on GitHub
https://github.com/edx/edx-platform/pull/1939#issuecomment-30463024.

[mhoeber]

ok by me to merge, and I can enhance sidebar text at later date

[nparlante]

Thanks Mark, sounds good.