search

Quansight / omnisci

Explorations on using MapD and Jupyter together.
4 stars 1 forks source link

Fix ibis.omniscidb docstrings #68

Closed xmnlab closed 4 years ago

xmnlab commented 4 years ago

As in a new feature Ibis should check docstring on CI, we should fix omniscidb docstrings

xmnlab commented 4 years ago 
./ibis/omniscidb/client.py:159 in public method `to_ibis`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:163 in public method `from_ibis`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:178 in public class `OmniSciDBDefaultCursor`:
        D200: One-line docstring should fit on one line with quotes (found 2)
./ibis/omniscidb/client.py:178 in public class `OmniSciDBDefaultCursor`:
        D400: First line should end with a period (not 'y')
./ibis/omniscidb/client.py:184 in public method `to_df`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:195 in public method `__enter__`:
        D105: Missing docstring in magic method
./ibis/omniscidb/client.py:199 in public method `__exit__`:
        D105: Missing docstring in magic method
./ibis/omniscidb/client.py:204 in public class `OmniSciDBGeoCursor`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:204 in public class `OmniSciDBGeoCursor`:
        D400: First line should end with a period (not 'y')
./ibis/omniscidb/client.py:208 in public method `to_df`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:249 in public class `OmniSciDBQuery`:
        D101: Missing docstring in public class
./ibis/omniscidb/client.py:260 in public class `OmniSciDBTable`:
        D200: One-line docstring should fit on one line with quotes (found 3)
./ibis/omniscidb/client.py:260 in public class `OmniSciDBTable`:
        D211: No blank lines allowed before class docstring (found 1)
./ibis/omniscidb/client.py:260 in public class `OmniSciDBTable`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:291 in public method `invalidate_metadata`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:294 in public method `refresh`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:298 in public method `metadata`:
        D400: First line should end with a period (not 't')
./ibis/omniscidb/client.py:310 in public method `drop`:
        D200: One-line docstring should fit on one line with quotes (found 3)
./ibis/omniscidb/client.py:310 in public method `drop`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:315 in public method `truncate`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:319 in public method `load_data`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:319 in public method `load_data`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:319 in public method `load_data`:
        D401: First line should be in imperative mood (perhaps 'Wrap', not 'Wraps')
./ibis/omniscidb/client.py:335 in public method `name`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:339 in public method `rename`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:339 in public method `rename`:
        D400: First line should end with a period (not 'o')
./ibis/omniscidb/client.py:369 in public method `alter`:
        D202: No blank lines allowed after function docstring (found 1)
./ibis/omniscidb/client.py:400 in public class `OmniSciDBClient`:
        D101: Missing docstring in public class
./ibis/omniscidb/client.py:421 in public method `__init__`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:421 in public method `__init__`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/client.py:479 in public method `__del__`:
        D105: Missing docstring in magic method
./ibis/omniscidb/client.py:482 in public method `__enter__`:
        D105: Missing docstring in magic method
./ibis/omniscidb/client.py:486 in public method `__exit__`:
        D105: Missing docstring in magic method
./ibis/omniscidb/client.py:489 in public method `log`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:493 in public method `close`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/client.py:548 in private method `_get_table_schema`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:548 in private method `_get_table_schema`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/client.py:566 in private method `_execute`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:566 in private method `_execute`:
        D400: First line should end with a period (not ':')
./ibis/omniscidb/client.py:608 in public method `drop_database`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:633 in public method `create_user`:
        D400: First line should end with a period (not 'r')
./ibis/omniscidb/client.py:653 in public method `alter_user`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/client.py:677 in public method `drop_user`:
        D400: First line should end with a period (not 'r')
./ibis/omniscidb/client.py:689 in public method `create_view`:
        D400: First line should end with a period (not 'n')
./ibis/omniscidb/client.py:704 in public method `drop_view`:
        D400: First line should end with a period (not 'w')
./ibis/omniscidb/client.py:766 in public method `drop_table`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:792 in public method `truncate_table`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:804 in public method `drop_table_or_view`:
        D200: One-line docstring should fit on one line with quotes (found 3)
./ibis/omniscidb/client.py:804 in public method `drop_table_or_view`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:852 in public method `load_data`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/client.py:852 in public method `load_data`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:852 in public method `load_data`:
        D401: First line should be in imperative mood (perhaps 'Wrap', not 'Wraps')
./ibis/omniscidb/client.py:868 in public method `current_database`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:871 in public method `set_database`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:886 in public method `exists_database`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:889 in public method `list_databases`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:893 in public method `exists_table`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/client.py:907 in public method `list_tables`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:925 in public method `get_schema`:
        D400: First line should end with a period (not 'e')
./ibis/omniscidb/client.py:953 in public method `sql`:
        D400: First line should end with a period (not 'n')
./ibis/omniscidb/client.py:953 in public method `sql`:
        D414: Section has no content ('Parameters')
./ibis/omniscidb/client.py:953 in public method `sql`:
        D414: Section has no content ('Parameters')
./ibis/omniscidb/client.py:975 in public method `version`:
        D102: Missing docstring in public method
./ibis/omniscidb/client.py:983 in public function `omniscidb_to_ibis_dtype`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/ddl.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/ddl.py:20 in public class `OmniSciDBQualifiedSQLStatement`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:25 in public class `OmniSciDBDDL`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:29 in public class `OmniSciDBDML`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:34 in public class `CreateDDL`:
        D400: First line should end with a period (not 'L')
./ibis/omniscidb/ddl.py:37 in public class `DropObject`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:41 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:47 in public class `DropTable`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:69 in public class `CreateTable`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/ddl.py:69 in public class `CreateTable`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/ddl.py:89 in public method `pieces`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:94 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:98 in public class `CreateTableWithSchema`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:106 in public method `with_params`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:128 in public class `CTAS`:
        D200: One-line docstring should fit on one line with quotes (found 3)
./ibis/omniscidb/ddl.py:128 in public class `CTAS`:
        D400: First line should end with a period (not 't')
./ibis/omniscidb/ddl.py:152 in public class `CreateView`:
        D400: First line should end with a period (not 'w')
./ibis/omniscidb/ddl.py:167 in public class `DropView`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:175 in public class `AlterUser`:
        D400: First line should end with a period (not 'r')
./ibis/omniscidb/ddl.py:204 in public method `pieces`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:209 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:214 in public class `CreateUser`:
        D400: First line should end with a period (not 'r')
./ibis/omniscidb/ddl.py:223 in public method `pieces`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:229 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:234 in public class `DropUser`:
        D400: First line should end with a period (not 'r')
./ibis/omniscidb/ddl.py:241 in public method `pieces`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:244 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:248 in public class `AlterTable`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:268 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:274 in public class `RenameTable`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:295 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:302 in public class `TruncateTable`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:310 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:315 in public class `CacheTable`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:321 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:328 in public class `CreateDatabase`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:333 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:345 in public class `DropDatabase`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:357 in public function `format_schema`:
        D103: Missing docstring in public function
./ibis/omniscidb/ddl.py:371 in public class `InsertPandas`:
        D101: Missing docstring in public class
./ibis/omniscidb/ddl.py:396 in public method `pieces`:
        D102: Missing docstring in public method
./ibis/omniscidb/ddl.py:406 in public method `compile`:
        D102: Missing docstring in public method
./ibis/omniscidb/identifiers.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/identifiers.py:136 in public function `quote_identifier`:
        D103: Missing docstring in public function
./ibis/omniscidb/api.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/api.py:9 in public function `compile`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/api.py:9 in public function `compile`:
        D400: First line should end with a period (not 'g')
./ibis/omniscidb/api.py:23 in public function `verify`:
        D205: 1 blank line required between summary line and description (found 0)
./ibis/omniscidb/api.py:23 in public function `verify`:
        D400: First line should end with a period (not 'n')
./ibis/omniscidb/api.py:45 in public function `connect`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/compiler.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/compiler.py:16 in public function `build_ast`:
        D103: Missing docstring in public function
./ibis/omniscidb/compiler.py:30 in public function `to_sql`:
        D103: Missing docstring in public function
./ibis/omniscidb/compiler.py:39 in public class `OmniSciDBSelectBuilder`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:52 in public class `OmniSciDBQueryBuilder`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:66 in public class `OmniSciDBQueryContext`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:78 in public class `OmniSciDBSelect`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:83 in public method `translator`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:87 in public method `table_set_formatter`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:90 in public method `format_select_set`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:93 in public method `format_group_by`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:113 in public method `format_limit`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:128 in public class `OmniSciDBTableSetFormatter`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:138 in public method `get_result`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:203 in public class `OmniSciDBExprTranslator`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:212 in public method `name`:
        D102: Missing docstring in public method
./ibis/omniscidb/compiler.py:217 in public class `OmniSciDBDialect`:
        D101: Missing docstring in public class
./ibis/omniscidb/compiler.py:232 in public function `omniscidb_rewrite_all`:
        D103: Missing docstring in public function
./ibis/omniscidb/compiler.py:237 in public function `omniscidb_rewrite_any`:
        D103: Missing docstring in public function
./ibis/omniscidb/compiler.py:242 in public function `omniscidb_rewrite_not_all`:
        D103: Missing docstring in public function
./ibis/omniscidb/compiler.py:247 in public function `omniscidb_rewrite_not_any`:
        D103: Missing docstring in public function
./ibis/omniscidb/__init__.py:1 at module level:
        D104: Missing docstring in public package
./ibis/omniscidb/operations.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/operations.py:124 in public function `fixed_arity`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:137 in public function `unary`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:203 in public function `unary_prefix_op`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:214 in public function `binary_infix_op`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:361 in public function `literal`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:426 in public function `raise_unsupported_expr_error`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:432 in public function `raise_unsupported_op_error`:
        D103: Missing docstring in public function
./ibis/omniscidb/operations.py:443 in public class `CaseFormatter`:
        D101: Missing docstring in public class
./ibis/omniscidb/operations.py:460 in public method `get_result`:
        D200: One-line docstring should fit on one line with quotes (found 4)
./ibis/omniscidb/operations.py:460 in public method `get_result`:
        D400: First line should end with a period (not ':')
./ibis/omniscidb/operations.py:567 in public class `NumericTruncate`:
        D400: First line should end with a period (not 's')
./ibis/omniscidb/operations.py:576 in public class `Conv_4326_900913_X`:
        D200: One-line docstring should fit on one line with quotes (found 3)
./ibis/omniscidb/operations.py:584 in public class `Conv_4326_900913_Y`:
        D200: One-line docstring should fit on one line with quotes (found 4)
./ibis/omniscidb/operations.py:596 in public class `ByteLength`:
        D400: First line should end with a period (not 'h')
./ibis/omniscidb/tests/conftest.py:1 at module level:
        D100: Missing docstring in public module
./ibis/omniscidb/tests/conftest.py:19 in public function `con`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:31 in public function `session_con`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:44 in public function `alltypes`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:49 in public function `awards_players`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:54 in public function `batting`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:59 in public function `df_alltypes`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:65 in public function `translate`:
        D200: One-line docstring should fit on one line with quotes (found 4)
./ibis/omniscidb/tests/conftest.py:65 in public function `translate`:
        D400: First line should end with a period (not ':')
./ibis/omniscidb/tests/conftest.py:81 in public function `temp_table`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:91 in public function `test_data_db`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/conftest.py:96 in public function `temp_database`:
        D103: Missing docstring in public function
./ibis/omniscidb/tests/__init__.py:1 at module level:
        D104: Missing docstring in public package
xmnlab commented 4 years ago

PR https://github.com/ibis-project/ibis/pull/1996

xmnlab commented 4 years ago

done.