diff --git a/README.md b/README.md index 316907f..8dc4829 100644 --- a/README.md +++ b/README.md @@ -26,22 +26,22 @@ rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes. These style guides are licensed under the CC-By 3.0 License, which encourages -you to share these documents. See http://creativecommons.org/licenses/by/3.0/ +you to share these documents. See [https://creativecommons.org/licenses/by/3.0/](https://creativecommons.org/licenses/by/3.0/) for more details. - + -[cpp]: http://google.github.io/styleguide/cppguide.html -[objc]: http://google.github.io/styleguide/objcguide.xml -[java]: http://google.github.io/styleguide/javaguide.html -[py]: http://google.github.io/styleguide/pyguide.html -[r]: http://google.github.io/styleguide/Rguide.xml -[sh]: http://google.github.io/styleguide/shell.xml -[htmlcss]: http://google.github.io/styleguide/htmlcssguide.xml -[js]: http://google.github.io/styleguide/javascriptguide.xml -[angular]: http://google.github.io/styleguide/angularjs-google-style.html -[cl]: http://google.github.io/styleguide/lispguide.xml -[vim]: http://google.github.io/styleguide/vimscriptguide.xml +[cpp]: https://google.github.io/styleguide/cppguide.html +[objc]: https://google.github.io/styleguide/objcguide.xml +[java]: https://google.github.io/styleguide/javaguide.html +[py]: https://google.github.io/styleguide/pyguide.html +[r]: https://google.github.io/styleguide/Rguide.xml +[sh]: https://google.github.io/styleguide/shell.xml +[htmlcss]: https://google.github.io/styleguide/htmlcssguide.xml +[js]: https://google.github.io/styleguide/javascriptguide.xml +[angular]: https://google.github.io/styleguide/angularjs-google-style.html +[cl]: https://google.github.io/styleguide/lispguide.xml +[vim]: https://google.github.io/styleguide/vimscriptguide.xml [cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint [emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el -[xml]: http://google.github.io/styleguide/xmlstyle.html +[xml]: https://google.github.io/styleguide/xmlstyle.html diff --git a/Rguide.xml b/Rguide.xml index add76d3..45d5471 100644 --- a/Rguide.xml +++ b/Rguide.xml @@ -1,5 +1,5 @@ - +
@@ -378,8 +378,8 @@ CalculateSampleCovariance <- function(x, y, verbose = TRUE) { of the two systems, see Thomas Lumley's "Programmer's Niche: A Simple Class, in S3 and S4" in R News 4/1, 2004, pgs. 33 - 36: - - http://cran.r-project.org/doc/Rnews/Rnews_2004-1.pdf.) + + https://cran.r-project.org/doc/Rnews/Rnews_2004-1.pdf.)Use S3 objects and methods unless there is a strong reason to use S4 objects or methods. A primary justification for an S4 object diff --git a/angularjs-google-style.html b/angularjs-google-style.html index 47db589..f5c728e 100644 --- a/angularjs-google-style.html +++ b/angularjs-google-style.html @@ -1,5 +1,5 @@ - +
@@ -21,24 +21,24 @@ (or not apply) these recommendations, as relevant to their own use cases.This document describes style for AngularJS apps in google3. This guide - supplements and extends the + supplements and extends the Google JavaScript Style Guide.
Style Note: Examples on the AngularJS external webpage, and many external apps, are written in a style that freely uses closures, favors functional inheritance, and does not often use + href="https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml?showone=JavaScript_Types#JavaScript_Types"> JavaScript types. Google follows a more rigorous Javascript style to support JSCompiler optimizations and large code bases - see the javascript-style mailing list. This is not an Angular-specific issue, and is not discussed further in this style guide. (But if you want further reading: Martin Fowler on closures, much longer description, appendix A of the - + closure book has a good description of inheritance patterns and why it prefers pseudoclassical, - + Javascript, the Good Parts as a counter.)
Controllers are classes. Methods should be defined on MyCtrl.prototype. - See + See the JavaScript style guide
Google Angular applications should use the 'controller as' style to export the controller @@ -343,8 +343,8 @@ module.service('request', hello.request.Request);
Angular provides easy adapters to load modules and use the injector in Jasmine tests.
@@ -385,7 +385,7 @@ my.app.MyCtrl = function($http, myService) { diff --git a/cppguide.html b/cppguide.html index f91ca9b..d09872d 100644 --- a/cppguide.html +++ b/cppguide.html @@ -617,7 +617,7 @@ bool UpdateInternals(Frobber* f, int newval) {Namespaces wrap the entire source file after includes, - + gflags definitions/declarations and forward declarations of classes from other namespaces.
@@ -1155,7 +1155,7 @@ in some cases. operations for them can be confusing, nonsensical, or outright incorrect. Copy/assigment operations for base class types are hazardous, because use of them can lead to -object +object slicing. Defaulted or carelessly-implemented copy operations can be incorrect, and the resulting bugs can be confusing and difficult to diagnose. @@ -1689,7 +1689,7 @@ reasons, we allow data members of a test fixture class to beprotected
when using
-Google
+Google
Test).
@@ -2715,7 +2715,7 @@ may select a different overload than you expect).
<<
operators interferes with
internationalization, because it bakes word order into the
-code, and streams' support for localization is
+code, and streams' support for localization is
flawed.The - + Boost library collection is a popular collection of peer-reviewed, free, open-source C++ libraries.
boost/call_traits.hpp
boost/compressed_pair.hpp
boost/graph
,
except serialization (adj_list_serialize.hpp
) and
parallel/distributed algorithms and data structures
(boost/graph/parallel/*
and
boost/graph/distributed/*
).boost/property_map
, except
parallel/distributed property maps (boost/property_map/parallel/*
).boost/iterator
boost/polygon/voronoi_diagram.hpp
, and
boost/polygon/voronoi_geometry_type.hpp
boost/bimap
boost/math/distributions
boost/multi_index
boost/heap
boost/container/flat_map
, and
boost/container/flat_set
boost/intrusive
.boost/array.hpp
: use
std::array
instead.boost/ptr_container
: use containers of
std::unique_ptr
instead.Even for experts, std::hash
specializations are
@@ -3963,7 +3963,7 @@ project.
(More on encodings and when and how to specify them can be - found in Handling + found in Handling character encodings in HTML and CSS.)
@@ -239,7 +239,7 @@
(It’s recommended to use HTML, as text/html
. Do not use
- XHTML. XHTML, as application/xhtml+xml
,
+ XHTML. XHTML, as application/xhtml+xml
,
lacks both browser and infrastructure support and offers
less room for optimization than HTML.)
- Use tools such as the W3C + Use tools such as the W3C HTML validator to test.
@@ -435,7 +435,7 @@
For file size optimization and scannability purposes, consider omitting optional tags. - The HTML5 + The HTML5 specification defines what tags can be omitted.
@@ -478,9 +478,9 @@
Specifying type
attributes in these contexts is
not necessary as HTML5 implies
- text/css
+ text/css
and
- text/javascript
+ text/javascript
as defaults. This can be safely done even for older browsers.
- Use tools such as the W3C + Use tools such as the W3C CSS validator to test.
@@ -698,7 +698,7 @@
- CSS offers a variety of shorthand
+ CSS offers a variety of shorthand
properties (like font
)
that should be used whenever possible, even in cases where
only one value is explicitly set.
@@ -880,7 +880,7 @@
- Indent all block + Indent all block content, that is rules within rules as well as declarations, so to reflect hierarchy and improve understanding.
@@ -951,7 +951,7 @@Always use a single space between the last selector and the opening - brace that begins the declaration + brace that begins the declaration block.
@@ -1035,7 +1035,7 @@
Exception: If you do need to use the @charset
rule,
- use double quotation marks—single
+ use double quotation marks—single
quotation marks are not permitted.
Braces follow the Kernighan and Ritchie style -("Egyptian brackets") +("Egyptian brackets") for nonempty blocks and block-like constructs:
else
or a
@@ -729,7 +729,7 @@ Foo.aStaticMethod(); // good
It is extremely rare to override Object.finalize
.
Tip: Don't do it. If you absolutely must, first read and understand -Effective Java +Effective Java Item 7, "Avoid Finalizers," very carefully, and then don't do it.
For that reason, it is best to use goog.inherits()
from
-
+
the Closure Library
or a similar library function.
@@ -804,7 +804,7 @@
Many JavaScript libraries, including
-
+
the Closure Library
and
@@ -1135,7 +1135,7 @@
goog.scope
may be used to shorten references to
namespaced symbols in programs using
- the Closure
+ the Closure
Library.
Only one goog.scope
invocation may be added per
file. Always place it in the global scope.
The --jscomp_warning=visibility compiler flag turns on compiler warnings for visibility violations. See - + Closure Compiler Warnings.
@@ -2220,7 +2220,7 @@All files, classes, methods and properties should be documented with
- JSDoc
+ JSDoc
comments with the appropriate tags
and types. Textual descriptions for properties,
methods, method parameters and method return values should be included
@@ -2235,7 +2235,7 @@
The JSDoc syntax is based on
-
+
JavaDoc. Many tools extract metadata from JSDoc comments to
perform code validation and optimizations. These comments must be
well-formed.
@type {Foo}
means "an instance of Foo",
but @lends {Foo}
means "the constructor Foo".
- The
+ The
JSDoc Toolkit docs have more information on this
annotation.
@@ -3313,7 +3313,7 @@
You may also see other types of JSDoc annotations in third-party code. These annotations appear in the - + JSDoc Toolkit Tag Reference but are currently discouraged in Google code. You should consider @@ -3389,7 +3389,7 @@
Use of JS compilers such as the - Closure Compiler + Closure Compiler is required for all customer-facing code.
diff --git a/jsoncstyleguide.xml b/jsoncstyleguide.xml index 0835c26..3a2ac25 100644 --- a/jsoncstyleguide.xml +++ b/jsoncstyleguide.xml @@ -70,7 +70,7 @@ Data should not be arbitrarily grouped for convenience.Dates should be strings formatted as recommended by RFC 3339
+Dates should be strings formatted as recommended by RFC 3339
Time duration values should be strings formatted as recommended by ISO 8601.
+Time duration values should be strings formatted as recommended by ISO 8601.
Latitude/Longitude should be strings formatted as recommended by ISO 6709. Furthermore, they should favor the ±DD.DDDD±DDD.DDDD degrees format.
+Latitude/Longitude should be strings formatted as recommended by ISO 6709. Furthermore, they should favor the ±DD.DDDD±DDD.DDDD degrees format.
In order to maintain a consistent interface across APIs, JSON objects should follow the structure outlined below. This structure applies to both requests and responses made with JSON. Within this structure, there are certain property names that are reserved for specific uses. These properties are NOT required; in other words, each reserved property may appear zero or one times. But if a service needs these properties, this naming convention is recommend. Here is a schema of the JSON structure, represented in Orderly format (which in turn can be compiled into a JSONSchema). You can few examples of the JSON structure at the end of this guide.
+In order to maintain a consistent interface across APIs, JSON objects should follow the structure outlined below. This structure applies to both requests and responses made with JSON. Within this structure, there are certain property names that are reserved for specific uses. These properties are NOT required; in other words, each reserved property may appear zero or one times. But if a service needs these properties, this naming convention is recommend. Here is a schema of the JSON structure, represented in Orderly format (which in turn can be compiled into a JSONSchema). You can few examples of the JSON structure at the end of this guide.
Client sets this value and server echos data in the response. This is useful in JSON-P and batch situations , where the user can use the context
to correlate responses with requests. This property is a top-level property because the context
should present regardless of whether the response was successful or an error. context
differs from id
in that context
is specified by the user while id
is assigned by the service.
Example:
Request #1:
Request #2:
Response #1:
@@ -572,7 +572,7 @@ Property Value Type: stringdata
Property Value Type: stringdata
-Represents the etag for the response. Details about ETags in the GData APIs can be found here: http://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning
Example:
+Represents the etag for the response. Details about ETags in the GData APIs can be found here: https://code.google.com/apis/gdata/docs/2.0/reference.html#ResourceVersioning
Example:
data
Property Value Type: string (formatted as specified in BCP 47)data (or any child element)
-Indicates the language of the rest of the properties in this object. This property mimics HTML's lang
property and XML's xml:lang
properties. The value should be a language value as defined in BCP 47. If a single JSON object contains data in multiple languages, the service is responsible for developing and documenting an appropriate location for the lang
property.
Example:
+Indicates the language of the rest of the properties in this object. This property mimics HTML's lang
property and XML's xml:lang
properties. The value should be a language value as defined in BCP 47. If a single JSON object contains data in multiple languages, the service is responsible for developing and documenting an appropriate location for the lang
property.
Example:
data
-Indicates the last date/time (RFC 3339) the item was updated, as defined by the service.
Example:
+Indicates the last date/time (RFC 3339) the item was updated, as defined by the service.
Example:
data
data
{
"data": {
"self": { },
- "selfLink": "http://www.google.com/feeds/album/1234"
+ "selfLink": "https://www.google.com/feeds/album/1234"
}
}
@@ -806,7 +806,7 @@ Property Value Type: object / stringdata
{
"data": {
"edit": { },
- "editLink": "http://www.google.com/feeds/album/1234/edit"
+ "editLink": "https://www.google.com/feeds/album/1234/edit"
}
}
@@ -823,7 +823,7 @@ Property Value Type: object / stringdata
{
"data": {
"next": { },
- "nextLink": "http://www.google.com/feeds/album/1234/next"
+ "nextLink": "https://www.google.com/feeds/album/1234/next"
}
}
@@ -840,7 +840,7 @@ Property Value Type: object / stringdata
{
"data": {
"previous": { },
- "previousLink": "http://www.google.com/feeds/album/1234/next"
+ "previousLink": "https://www.google.com/feeds/album/1234/next"
}
}
@@ -1001,7 +1001,7 @@ Property Value Type: stringerror.errors
error.errors
The words below are reserved by the JavaScript language and cannot be referred to using dot notation. The list represents best knowledge of keywords at this time; the list may change or vary based on your specific execution environment.
From the ECMAScript Language Specification 5th Edition
+The words below are reserved by the JavaScript language and cannot be referred to using dot notation. The list represents best knowledge of keywords at this time; the list may change or vary based on your specific execution environment.
From the ECMAScript Language Specification 5th Edition
-Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. +Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License.
Revision 0.9
diff --git a/lispguide.xml b/lispguide.xml
index e5b6dc3..4a06b45 100644
--- a/lispguide.xml
+++ b/lispguide.xml
@@ -85,7 +85,7 @@ Robert Brown