myramnath / common-schema

Automatically exported from code.google.com/p/common-schema
0 stars 0 forks source link

dependencies procedures need documentation #17

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Documentation needed for 
- get_sql_dependencies
- get_view_dependencies
- get_routine_dependencies
- get_event_dependencies (tbd)

I propose to document the output (and logic where appropriate) once in 
get_sql_dependencies, and document calls and usage for each other procedure. 
Those can all refer to the get_sql_dependencies documentation for the output.

Original issue reported on code.google.com by roland.bouman on 19 Sep 2011 at 9:03

GoogleCodeExporter commented 9 years ago
Best to first create the tests (see tests/ directory), so that we have reliable 
expected output, and can build up the documentation based on that.

Original comment by shlomi.n...@gmail.com on 19 Sep 2011 at 12:10

GoogleCodeExporter commented 9 years ago
ok - I just saw you added a bunch. thanks, I'll pull tonight and add tests.

Original comment by roland.bouman on 19 Sep 2011 at 12:25

GoogleCodeExporter commented 9 years ago
# tests: please use
ant deploy_innodb_plugin
ant test
# replace "deploy_innodb_plugin" with the type of deploy you wish to make
#
# docs: please see doc/templates. Run
ant doc
# to generate documentation.

Original comment by shlomi.n...@gmail.com on 19 Sep 2011 at 5:15

GoogleCodeExporter commented 9 years ago
finalizing documentation

Original comment by shlomi.n...@gmail.com on 28 Nov 2011 at 4:55

GoogleCodeExporter commented 9 years ago
Documentation committed on revision 175

Original comment by shlomi.n...@gmail.com on 28 Nov 2011 at 5:01