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

Add idiomatic code performance and developer-facing docs to goals #120

Merged
merged 20 commits into from
Aug 20, 2020
Merged

Add idiomatic code performance and developer-facing docs to goals #120

merged 20 commits into from
Aug 20, 2020

Conversation

jonmeow
Copy link
Contributor

@jonmeow jonmeow commented Jul 22, 2020

Most of this is addressing issue #106.

Two new explicit sub-goals:

I think both of these are on people's minds and assumed, but still worth spelling out.

@jonmeow jonmeow requested review from chandlerc and josh11b July 22, 2020 20:27
@googlebot googlebot added the cla: yes PR meets CLA requirements according to bot. label Jul 22, 2020
@jonmeow jonmeow changed the title Addressing goal doc suggestisons from #106 Addressing goal doc suggestions from #106 Jul 22, 2020
@jonmeow jonmeow linked an issue Jul 22, 2020 that may be closed by this pull request
Copy link
Contributor

@josh11b josh11b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonmeow
Copy link
Contributor Author

jonmeow commented Jul 22, 2020

new tools has a higher cost than many people appreciate." --
John Carmack

I believe should be:

new tools has a higher cost than many people appreciate."
--John Carmack

https://english.stackexchange.com/questions/28601/appropriate-dash-to-use-when-attributing-a-quotation#:~:text=Let%20a%20dash%20precede%20the,both)%20following%20a%20direct%20quotation.&text=In%20contemporary%20usage%2C%20block%20quotes,make%20the%20quotation%20stand%20out.

Your reference prefers em dash (which as an aside, by https://developers.google.com/style/dashes, would have no spaces around it). This is what I was doing before #116; there, I altered the style to " -- " instead of an em dash, stemming from related conversation on the goals PR and for the reasons noted in #116 . There are spaces because I find "text--text" hard to read. Once the spaces are present, the rest is just a matter of word wrap.

@josh11b
Copy link
Contributor

josh11b commented Jul 22, 2020 via email

@jonmeow
Copy link
Contributor Author

jonmeow commented Jul 22, 2020

Higher up on that page is what I was referring to:
The source of an epigraph is usually given on a line following the
quotation, sometimes preceded by a dash. Nowhere on that page is it suggesting that there should be no whitespace between the epigraph and the source.

On Wed, Jul 22, 2020 at 3:07 PM Jon Meow @.***> wrote: new tools has a higher cost than many people appreciate." -- John Carmack https://twitter.com/id_aa_carmack/status/989951283900514304 I believe should be: new tools has a higher cost than many people appreciate." --John Carmack https://twitter.com/id_aa_carmack/status/989951283900514304 https://english.stackexchange.com/questions/28601/appropriate-dash-to-use-when-attributing-a-quotation#:~:text=Let%20a%20dash%20precede%20the,both)%20following%20a%20direct%20quotation.&text=In%20contemporary%20usage%2C%20block%20quotes,make%20the%20quotation%20stand%20out . Your reference prefers em dash (which as an aside, by https://developers.google.com/style/dashes, would have no spaces around it). This is what I was doing before #116 <#116>; there, I altered the style to " -- " instead of an em dash, stemming from related conversation on the goals PR. There are spaces because I find "text--text" hard to read. Once the spaces are present, the rest is just a matter of word wrap. — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#120 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADUNHVYCB6AOXEKIDBXPES3R45PI7ANCNFSM4PFCGN2Q .
-- Josh

I think I understand what you want now, done.

@jonmeow jonmeow changed the title Addressing goal doc suggestions from #106 Be explicit about idiomatic code and user-facing docs in goals. Jul 23, 2020
@jonmeow jonmeow changed the title Be explicit about idiomatic code and user-facing docs in goals. Be explicit about idiomatic code and user-facing docs in goals Jul 23, 2020
@jonmeow jonmeow changed the title Be explicit about idiomatic code and user-facing docs in goals Be explicit about idiomatic code and developer-facing docs in goals Jul 23, 2020
@jonmeow jonmeow changed the title Be explicit about idiomatic code and developer-facing docs in goals Add idiomatic code performance and developer-facing docs to goals Jul 23, 2020
@jonmeow jonmeow added proposal A proposal proposal rfc Proposal with request-for-comment sent out labels Jul 23, 2020
docs/project/goals.md Outdated Show resolved Hide resolved
docs/project/goals.md Outdated Show resolved Hide resolved
jonmeow and others added 2 commits July 24, 2020 18:12
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
docs/project/goals.md Outdated Show resolved Hide resolved
docs/project/goals.md Outdated Show resolved Hide resolved
jonmeow and others added 2 commits July 27, 2020 11:55
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Copy link
Contributor

@geoffromer geoffromer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This generally looks good; just a few wording suggestions.

docs/project/goals.md Outdated Show resolved Hide resolved
docs/project/goals.md Outdated Show resolved Hide resolved
docs/project/goals.md Outdated Show resolved Hide resolved
docs/project/goals.md Show resolved Hide resolved
proposals/p0120.md Outdated Show resolved Hide resolved
proposals/p0120.md Outdated Show resolved Hide resolved
Co-authored-by: Geoff Romer <gromer@google.com>
Co-authored-by: Dmitri Gribenko <gribozavr@gmail.com>
@josh11b
Copy link
Contributor

josh11b commented Jul 31, 2020

Please include the change from #126 in this as well. That is part of addressing the issues from #106.

Copy link
Contributor Author

@jonmeow jonmeow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include the change from #126 in this as well. That is part of addressing the issues from #106.

I've adopted #126 with edits to the phrasing based on discussion with @zygoloid about how to get this right.

docs/project/goals.md Outdated Show resolved Hide resolved
Additionally, while considering justification for changes in
[PR 80](https://github.com/carbon-language/carbon-lang/pull/80), I noted there
is no explicit goal to provide developer-facing documentation. I believe this is
and intended part of the community goals, and could be inferred from current

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: s/and intended/an intended/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@jonmeow jonmeow dismissed chandlerc’s stale review August 20, 2020 22:25

Proposal accepted, no new requests since

@jonmeow jonmeow merged commit 054e0d0 into carbon-language:trunk Aug 20, 2020
@jonmeow jonmeow deleted the goals-edits branch August 20, 2020 22:27
@sidney13 sidney13 self-requested a review August 25, 2020 01:15
Copy link
Contributor

@sidney13 sidney13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal accepted, decision created.

@sidney13 sidney13 added proposal accepted Decision made, proposal accepted and removed needs decision labels Sep 8, 2020
chandlerc pushed a commit that referenced this pull request Jun 28, 2022
- [RFC topic](https://forums.carbon-lang.dev/t/rfc-add-idiomatic-code-performance-and-developer-facing-docs-to-goals/105)
- [Decision](https://forums.carbon-lang.dev/t/request-for-decision-add-idiomatic-code-performance-and-developer-facing-docs-to-goals/116)

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Co-authored-by: Geoff Romer <gromer@google.com>
Co-authored-by: Dmitri Gribenko <gribozavr@gmail.com>

Most of this is addressing issue #106.

Two new explicit sub-goals:

- Idiomatic code should be performant, stemming from #106.
- User-facing documentation, separate thought from #83 discussion.

I think both of these are on people's minds and assumed, but still worth spelling out.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes PR meets CLA requirements according to bot. proposal accepted Decision made, proposal accepted proposal rfc Proposal with request-for-comment sent out proposal A proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changes requested to goals doc
8 participants