Skip to content

Update Java and C++ style guides with various changes since last update #196

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

Merged
merged 1 commit into from
Nov 18, 2016
Merged

Conversation

shicks
Copy link
Member

@shicks shicks commented Nov 3, 2016

No description provided.

@shicks
Copy link
Member Author

shicks commented Nov 3, 2016

Linking to the internal style groups to make sure there's buy-in before we merge this.


<p>Namespaces wrap the entire source file after
includes,
<a href="https://gflags.github.io/gflags/">
<a href="http://google-gflags.googlecode.com/">

Choose a reason for hiding this comment

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

I think we want the LHS github URL.

Copy link
Member Author

Choose a reason for hiding this comment

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

This has been reverted. The internal version of this file had gotten out of sync.

@@ -1594,50 +1599,30 @@ <h3 id="Access_Control">Access Control</h3>
be <code>protected</code> when using


<a href="https://code.google.com/p/googletest/">Google
<a href="http://code.google.com/p/googletest/">Google

Choose a reason for hiding this comment

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

Do we really want to drop https? Double check other URLs in this edit. Also this particular URL should be https://github.com/google/googletest.

Copy link
Member Author

Choose a reason for hiding this comment

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

Same here - this should be fixed now.

Choose a reason for hiding this comment

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

Looks good.

@geoffromer
Copy link
Collaborator

LGTM (C++ only, didn't look at Java)

@tkruse
Copy link

tkruse commented Nov 6, 2016

BTW, without wanting to spoil all the fun of manually editing HTML, maybe any of the google maintainers would be interested in converting all guidelines to markdown? As I sketched here a long time ago: #36

@shicks
Copy link
Member Author

shicks commented Nov 6, 2016

Internally the new JS guide is markdown. Unfortunately, or internal
markdown renderer is a flavor of hoedown, whereas github pages uses
kramdown, so we end up converting it to HTML on the way out anyway...

On Nov 5, 2016 6:10 PM, "Thibault Kruse" [email protected] wrote:

BTW, without wanting to spoil all the fun of manually editing HTML, maybe
any of the google maintainers would be interested in converting all
guidelines to markdown? As I sketched here a long time ago: #36
#36


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#196 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAIyG1U8_vUtfUEZUtZ-_03JCNJelMAYks5q7SkGgaJpZM4KpCqi
.

@tkruse
Copy link

tkruse commented Nov 6, 2016

Interesting. But still how is html better than hoedown on github?

@shicks
Copy link
Member Author

shicks commented Nov 7, 2016

Because we can actually produce it and have it render correctly. Our style
guides take significant advantage of one of the nonstandard markdown
features (classes on code blocks and headings) which is unfortunately
incompatible between the two engines. So we'd need to do some sort of
postprocessing on it in any case, which is more moving parts that don't
exist yet and would need maintenance. Additionally, our externalization
process only works on HTML, so we'd need to devise a way to scrub markdown
directly, which also doesn't exist yet.

It's a great feature request to work toward, and I'd personally love to see
it happen, but given that our style guides are all volunteer/20% efforts,
it's not likely to happen in the near term.

On Nov 5, 2016 9:58 PM, "Thibault Kruse" [email protected] wrote:

Interesting. But still how is html better than hoedown on github?


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#196 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAIyG_8sIzEufbQZv_SSCWuevDCTyOZEks5q7V5agaJpZM4KpCqi
.

@tkruse
Copy link

tkruse commented Nov 8, 2016

So this "externalization process" cut's away pieces that must not be open-source for now?

Or could Google publish the raw hoedown and externalization scripts on github as well as the HTML so that contributors may both contribute to the raw sources directly as well as work on the transformation?

Additionally, what about the guides provided as xml files (objc, shell, lisp, ...), are they internally in hoedown, or is it interesting for them to be converted to markdown?

@shicks
Copy link
Member Author

shicks commented Nov 17, 2016

Internal Java people are okay with this. Can somebody merge it?

@shicks shicks merged commit db0a263 into google:gh-pages Nov 18, 2016
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.

5 participants