From 3a9aa519496be9da6283b847f38d9a2deaf682aa Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Sun, 22 Mar 2015 12:33:43 +0100 Subject: [PATCH] fix(docs):better introduction and version handling Make it cristal clear what the crate version means, and what version of the documentation you are looking at. Also do this in the README file. Assure that 'Google' is capitalized. --- gen/groupsmigration1/README.md | 10 ++++++---- gen/groupsmigration1/src/lib.rs | 13 +++++++------ src/mako/README.md.mako | 2 +- src/mako/lib/lib.mako | 17 +++++++++-------- 4 files changed, 23 insertions(+), 19 deletions(-) diff --git a/gen/groupsmigration1/README.md b/gen/groupsmigration1/README.md index 96a2d27819..563da63508 100644 --- a/gen/groupsmigration1/README.md +++ b/gen/groupsmigration1/README.md @@ -3,11 +3,15 @@ DO NOT EDIT ! This file was generated automatically from 'src/mako/README.md.mako' DO NOT EDIT ! --> -The `groupsmigration1` library allows access to all features of *Groups Migration*. +The `google-groupsmigration1` library allows access to all features of the *Google Groups Migration* service. +This documentation was generated from *Groups Migration* crate version *0.0.1+20140416*, where *20140416* is the exact revision of the *groupsmigration:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.0.1*. + +Everything else about the *Groups Migration* *v1* API can be found at the +[official documentation site](https://developers.google.com/google-apps/groups-migration/). # Features -It seems there is nothing you can do here ... . +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.GroupsMigration.html) ... * archive * [*insert*](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.ArchiveInsertCall.html) @@ -18,8 +22,6 @@ Upload supported by ... * [*insert archive*](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.ArchiveInsertCall.html) -Everything else about the *Groups Migration* *v1* API can be found at the -[official documentation site](https://developers.google.com/google-apps/groups-migration/). # Structure of this Library diff --git a/gen/groupsmigration1/src/lib.rs b/gen/groupsmigration1/src/lib.rs index 8383114269..ae99aa9a8a 100644 --- a/gen/groupsmigration1/src/lib.rs +++ b/gen/groupsmigration1/src/lib.rs @@ -2,11 +2,14 @@ // This file was generated automatically from 'src/mako/lib.rs.mako' // DO NOT EDIT ! -//! This documentation was generated from *Groups Migration* crate version *0.0.1+20140416*. -//! The original source code can be found [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/groupsmigration1). +//! This documentation was generated from *Groups Migration* crate version *0.0.1+20140416*, where *20140416* is the exact revision of the *groupsmigration:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.0.1*. +//! +//! Everything else about the *Groups Migration* *v1* API can be found at the +//! [official documentation site](https://developers.google.com/google-apps/groups-migration/). +//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/groupsmigration1). //! # Features //! -//! It seems there is nothing you can do here ... . +//! Handle the following *Resources* with ease from the central [hub](struct.GroupsMigration.html) ... //! //! * archive //! * [*insert*](struct.ArchiveInsertCall.html) @@ -17,10 +20,8 @@ //! * [*insert archive*](struct.ArchiveInsertCall.html) //! //! -//! Everything else about the *Groups Migration* *v1* API can be found at the -//! [official documentation site](https://developers.google.com/google-apps/groups-migration/). //! -//! Not what you are looking for ? Find all other google APIs in their Rust [documentation index](../index.html). +//! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](../index.html). //! //! # Structure of this Library //! diff --git a/src/mako/README.md.mako b/src/mako/README.md.mako index 53defd96ab..768f8fc2a2 100644 --- a/src/mako/README.md.mako +++ b/src/mako/README.md.mako @@ -7,7 +7,7 @@ <%block filter="markdown_comment">\ <%util:gen_info source="${self.uri}" />\ -The `${util.library_name()}` library allows access to all features of *${util.canonical_name()}*. +The `${util.crate_name()}` library allows access to all features of the *Google ${util.canonical_name()}* service. ${lib.docs(c, rust_doc=False)} <%lib:license /> \ No newline at end of file diff --git a/src/mako/lib/lib.mako b/src/mako/lib/lib.mako index c3667c0883..5832082bcd 100644 --- a/src/mako/lib/lib.mako +++ b/src/mako/lib/lib.mako @@ -56,13 +56,18 @@ # end for each method header_methods = (('Upload', upload_methods), ('Download', download_methods), ('Subscription', subscription_methods)) %>\ +This documentation was generated from *${util.canonical_name()}* crate version *${util.crate_version()}*, where *${revision}* is the exact revision of the *${id}* schema built by the [mako](http://www.makotemplates.org/) code generator *v${cargo.build_version}*. +% if documentationLink: + +Everything else about the *${util.canonical_name()}* *${api_version}* API can be found at the +[official documentation site](${documentationLink}). +% endif % if rust_doc: -This documentation was generated from *${util.canonical_name()}* crate version *${util.crate_version()}*. -The original source code can be found [on github](${util.github_source_root_url()}). +The original source code is [on github](${util.github_source_root_url()}). % endif # Features -% if len(c.rta_map) > 1: +% if len(c.rta_map) > 0 + (METHODS_RESOURCE in c.rta_map): Handle the following *Resources* with ease from the central ${link('hub', hub_url)} ... % elif METHODS_RESOURCE in c.rta_map: Use the following functionality with ease from the central ${link('hub', hub_url)} ... @@ -116,13 +121,9 @@ ${method_type} supported by ... % endif ## if methods % endfor ## for each method type -% if documentationLink: -Everything else about the *${util.canonical_name()}* *${api_version}* API can be found at the -[official documentation site](${documentationLink}). -% endif % if rust_doc: -Not what you are looking for ? Find all other google APIs in their Rust [documentation index](../index.html). +Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](../index.html). % endif # Structure of this Library