Skip to content

Tweak FAQ for placeholder syntax #2657

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

Closed
wants to merge 1 commit into from

Conversation

som-snytt
Copy link
Contributor

Fixes #2381

Addresses xs.map(_).

@SethTisue
Copy link
Member

SethTisue commented Dec 12, 2022

What you've written is good, but it isn't what the FAQ is for. The FAQ exists to host as short as possible answers and/or links to lengthier content hosted elsewhere.

If you feel the existing answer can be improved without making it longer, I'd merge that. And if you host a longer writeup elsewhere and feel we should link to it, adding that link would be a mergeable change.

But as it stands, this isn't a direction I want the FAQ to take.

@SethTisue
Copy link
Member

(Part of the problem is that a lot of the material you've added doesn't address questions that are actually frequently asked. The fact that topic X is frequently asked about doesn't mean that the best answer is something that goes into every nuance about X.)

@SethTisue
Copy link
Member

SethTisue commented Dec 12, 2022

One further thought: I acknowledge that it's perhaps sad or not ideal that there is such an unfilled gulf between the brief, just-the-basics style of documentation in the language tour and the very complete and technical style and not especially learner-friendly style used in the language specification. But even if that gap could or should be filled somehow, it isn't the FAQ's place to do it.

@SethTisue
Copy link
Member

SethTisue commented Dec 12, 2022

(cc @bishabosha and @sjrd , since this is good context to have for anyone who might be reviewing FAQ changes)

This was referenced Dec 12, 2022
@SethTisue SethTisue closed this Dec 12, 2022
@som-snytt
Copy link
Contributor Author

There might be a SO entry, but "why doesn't map(_) mean map(x => x)" is a FAQ. Maybe it should be a FAQ with an answer but no explanation. Not sure if there is currently an explanation short of the spec.

@som-snytt
Copy link
Contributor Author

Or instead of adding to the FAQ, we could start a section, "QOTOA" questions one tires of answering.

@som-snytt
Copy link
Contributor Author

Worth adding that the original "One-Question FAQ" was a thorough explanation.

Oh, the current FAQ found a clever solution to accommodate it:

image

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

Successfully merging this pull request may close these issues.

Placeholder FAQ claim overreaches
2 participants