Generate readmes for most service samples

[theacodes]

No description provided.

[jerjou]

It seems like github is making a bunch of the urls relative urls for some reason?

[jerjou]

Do we not want the links back to the docs anymore?

[theacodes]

I'm gonna revisit this one Jason has his docs tracker working.

[jerjou]

The rendered 'BigQuery_' in the second sentence here seems to appear as a link that goes nowhere (and the trailing underscore still appears) (ditto below)

[theacodes]

Fixed.

[jerjou]

This link 404s

[theacodes]

Fixed.

[jerjou]

Oh neat - does the script automatically run the script with no arguments, and include the output? That's super cool.

nit: Perhaps include the -h flag explicitly, to make clear that it's printing the help?

[theacodes]

Without or without the -h flag, it'll show the help. :)

[jerjou]

Hrm... I'm not seeing that:

$ python sync_query.py
usage: sync_query.py [-h] query
sync_query.py: error: too few arguments

$ python sync_query.py -h
usage: sync_query.py [-h] query

Command-line application to perform synchronous queries in BigQuery.

For more information, see the README.md under /bigquery.

Example invocation:
    $ python sync_query.py           'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'

positional arguments:
  query       BigQuery SQL Query.

optional arguments:
  -h, --help  show this help message and exit

[jerjou]

Hm... is it worth it to include this, if it doesn't include 'help' text?

[theacodes]

Yep.

[jerjou]

Weird random spaces here..

[theacodes]

Not sure why, but it's not the samplegen's fault.

[jerjou]

Should probably fix it before checking in the README that shows it, though.

I suspect it's because argparse is using the module's docstring for its help text, which includes a newline escape to fit under 80 characters (and a subsequent indent). If you escape the escape (ie \\) that should fix both the help text displayed when invoking the command, and the random spaces here.

[jerjou]

This link 404s

[theacodes]

Fixed.

[theacodes]

Done

On Thu, Oct 20, 2016 at 2:22 PM Jerjou notifications@github.com wrote:

@jerjou commented on this pull request.

In bigquery/api/README.rst.in
#599:

• show_help: true
  +- name: Load data by POST
• file: load_data_by_post.py
• show_help: true
  +- name: Load data from CSV
• file: load_data_from_csv.py
• show_help: true
  +- name: Load streaming data
• file: streaming.py
• show_help: true
  +- name: Export data to Cloud Storage
• file: export_data_to_cloud_storage.py
• show_help: true
  +- name: User auth with an installed app
• file: installed_app.py
• show_help: true

Hrm... I'm not seeing that:

$ python sync_query.py
usage: sync_query.py [-h] query
sync_query.py: error: too few arguments

$ python sync_query.py -h
usage: sync_query.py [-h] query

Command-line application to perform synchronous queries in BigQuery.

For more information, see the README.md under /bigquery.

Example invocation:
$ python sync_query.py 'SELECT corpus FROM publicdata.samples.shakespeare GROUP BY corpus'

positional arguments:
query BigQuery SQL Query.

optional arguments:
-h, --help show this help message and exit

---

In bigquery/cloud-client/README.rst
#599:

+To run this sample:
+
+.. code-block:: bash
+

• $ python sync_query.py

• usage: sync_query.py [-h] query

• Command-line application to perform synchronous queries in BigQuery.

• For more information, see the README.md under /bigquery.

• Example invocation:

•    $ python sync_query.py           'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'
  

Should probably fix it before checking in the README that shows it, though.

I suspect it's because argparse is using the module's docstring for its
help text, which includes a newline escape to fit under 80 characters (and
a subsequent indent). If you escape the escape (ie ) that should fix
both the help text displayed when invoking the command, and the random
spaces here.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#599, or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAPUc-Zzla9mAGVMJ9TY0O-pOzrKffN4ks5q19t4gaJpZM4KclUn
.