Recent Commits to styleguide:gh-pages (60)

Automated export from internal guides

PiperOrigin-RevId: 1015669081

Automated export from internal guides

PiperOrigin-RevId: 1015601094

Automated export from internal guides

PiperOrigin-RevId: 1015551194

Automated export from internal guides

PiperOrigin-RevId: 1014764300

js: add an example for annotating empty collections (#1074)

The tip about the compiler not inferring template parameters for empty
collections has no example.  Add one, and turn the tip into a regular
paragraph now that it has examples.

Contrast a collection whose template type is inferred from its
constructor argument with the empty collections that need annotations.

js: add a template literal example for long strings

The rule against line continuations covers template literals too, but
only shows how to split an ordinary string literal.  Add the template
literal version.

Automated export from internal guides

PiperOrigin-RevId: 1013515311

Automated export from internal guides

PiperOrigin-RevId: 1013398359

Automated export from internal guides

PiperOrigin-RevId: 1013177893

js: add an example for the destructuring tip

The tip to prefer object destructuring over array destructuring for
multiple values has no example.  Show both forms, including how the
array form loses the element names and per-element types.

js: turn the destructuring tip into a regular paragraph

Now that it has examples, it is no longer just a tip.

js: add an example for template parameter names

The naming rule for template parameters has no example.  Show names
that follow it and names that are not all-caps or not a single word.

markdown: sync some internal updates

This will make it easier to integrate newer versions with real content.
Add <a> anchors and good/bad code markers.

Automated export from internal guides

PiperOrigin-RevId: 1013080419

Automated export from internal guides

PiperOrigin-RevId: 1013025019

js: add an example for @const on legacy var declarations

The rule to annotate global `var` declarations with `@const` has no
example.  Add one.

Automated export from internal guides

PiperOrigin-RevId: 1012577731

Automated export from internal guides

PiperOrigin-RevId: 1012570710

drop html supplemental files

Now that all html guides have converted to markdown, we don't need
these JS or CSS files anymore.  Punt them.

cpp: migrate to markdown

Automated export from internal guides

PiperOrigin-RevId: 1010850167

Automated export from internal guides

PiperOrigin-RevId: 1010509341

typescript: migrate to markdown

This also contains some internal changes that weren't exported previously.

Automated export from internal guides

PiperOrigin-RevId: 1009345184

Automated export from internal guides

PiperOrigin-RevId: 1009174118

Automated export from internal guides

PiperOrigin-RevId: 1009140818

java: migrate to markdown

tcltk: link in external guide we use

We don't have one ourselves, but we refer to this one.

README: add a VCS section explicitly

README: unify the style guide lists into one

We're already mixing sources in the main list of guides, and having
a separate list isn't really helping that much.  Merge into one list
and call out provenance when reporting issues.

README: fold XML back into the main list

The longer explanation isn't really necessary here, and the details
are contained in the XML guide itself.  Other guides sometimes have
advice beyond purely formatting.

js: explain the rectangle rule

The function argument examples say one layout "violates the rectangle
rule" without saying what that is.  Add a short definition and link to
the full description in the google-java-format wiki.

js: link to a definition of CSP

"CSP environments" is not explained.  Spell out Content Security Policy
and link to a description of it.

Automated export from internal guides

PiperOrigin-RevId: 1007354033

Automated export from internal guides

PiperOrigin-RevId: 1006046694

Automated export from internal guides

PiperOrigin-RevId: 1005823146

Automated export from internal guides

PiperOrigin-RevId: 1005639216

Automated export from internal guides

PiperOrigin-RevId: 1005568362

Automated export from internal guides

PiperOrigin-RevId: 1004267654

Automated export from internal guides

PiperOrigin-RevId: 1004098447

link in new Rust guide #276

Fixes: #276

Automated export from internal guides

PiperOrigin-RevId: 1004009482

docguide: switch to autotoc

This lets GH pages generate the TOC for us.

docguide: run files through mdformat

This is to prepare for automatic export and make diffs easier to review.

Automated export from internal guides

PiperOrigin-RevId: 1003227363

Automated export from internal guides

PiperOrigin-RevId: 1002394198

README: add an editor section

Some guides touch on editors & tools, but many don't.
Start a section to cover these projects.

docguide: remove unused VERSION file

README: create a dedicated licensing section

Clarify/document the difference between written guides & code.

Automated export from internal guides

PiperOrigin-RevId: 1001469701

Automated export from internal guides

PiperOrigin-RevId: 1001293847

Automated export from internal guides

PiperOrigin-RevId: 1001270344

Automated export from internal guides

PiperOrigin-RevId: 1001096816

Automated export from internal guides

PiperOrigin-RevId: 1000931729

verilog: wrap `define in code span to fix Kramdown table parsing

Kramdown's table row validator only runs its :codespan and :span_html parsers (not :escaped_chars), so the backslash-escaped backtick in [\`define macros](#defines) opened an unclosed code span across the row's | delimiter and caused Kramdown to abort parsing the table. Wrap `define in a two-backtick inline code span so Kramdown renders the table, and drop the duplicate #sequential-logic anchor above #sequential-logic-registers.

lisp, vim: sync latest internal to add autotoc

C#, R: sync latest internal to add autotoc & good/bad code style

enable block html parsing for zippies

This doesn't directly support zippies, but it's needed in cases where
guides use <div> blocks as the first zippy element.  For now, it should
be a noop.

This resyncs the vim guide to the latest (with most zippies removed)
and replaces the manual Python TOC with an automatic one like most of
the other guides.

verilog: fix naming-overview table and colliding heading anchors

Convert the Hoedown multiline naming-overview table into a standard single-line Markdown table so Kramdown renders it as an HTML table instead of a definition list. Disambiguate colliding heading anchors and wrap macro references in inline code spans.

python: sync latest version

This includes good/bad code updates.