Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation strings are not set for all source files #46

Open
tisnik opened this issue Mar 8, 2019 · 0 comments
Open

Documentation strings are not set for all source files #46

tisnik opened this issue Mar 8, 2019 · 0 comments
Labels
bug Something isn't working

Comments

@tisnik
Copy link
Member

tisnik commented Mar 8, 2019 

rudra/utils/__init__.py
rudra/utils/__init__.py:1 at module level:
        D104: Missing docstring in public package
1
    Fail
rudra/deployments/__init__.py
rudra/deployments/__init__.py:1 at module level:
        D104: Missing docstring in public package
1
    Fail
tests/data_store/test_aws.py
tests/data_store/test_aws.py:1 at module level:
        D100: Missing docstring in public module
tests/data_store/test_aws.py:18 in public function `s3_bucket`:
        D103: Missing docstring in public function
tests/data_store/test_aws.py:25 in public function `s3`:
        D103: Missing docstring in public function
tests/data_store/test_aws.py:42 in public function `upload_dir`:
        D103: Missing docstring in public function
tests/data_store/test_aws.py:49 in public class `TestAmazonS3`:
        D101: Missing docstring in public class
tests/data_store/test_aws.py:51 in public method `test_connect_without_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:56 in public method `test_connect_with_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:63 in public method `test_disconnect_with_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:71 in public method `test_get_name`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:74 in public method `test_object_exists`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:77 in public method `test_upload_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:84 in public method `test_write_json_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:90 in public method `test_write_pickle_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:96 in public method `test_read_generic_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:101 in public method `test_list_bucket_objects`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:106 in public method `test_list_bucket_objects_filter`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:111 in public method `test_list_bucket_keys`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:116 in public method `test_s3_delete_object`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:123 in public method `test_s3_delete_objects`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:132 in public method `test_s3_clean_bucket`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:137 in public method `test_load_matlab_multi_matrix`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:143 in public method `test_s3_upload_folder`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:151 in public method `test_store_blob`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:157 in public method `test_read_yaml_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:165 in public method `test_read_pickle_file`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:174 in public function `emr`:
        D103: Missing docstring in public function
tests/data_store/test_aws.py:188 in public class `TestAmazonEMR`:
        D101: Missing docstring in public class
tests/data_store/test_aws.py:189 in public method `test_connect_without_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:194 in public method `test_connect_with_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:200 in public method `test_disconnect_with_creds`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:208 in public method `test_run_flow`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:232 in public method `test_terminate_job`:
        D102: Missing docstring in public method
tests/data_store/test_aws.py:259 in public method `test_terminate_jobs`:
        D102: Missing docstring in public method
33
    Fail
tests/data_store/test_local_store.py
tests/data_store/test_local_store.py:1 at module level:
        D100: Missing docstring in public module
tests/data_store/test_local_store.py:12 in public function `tmp_dir`:
        D103: Missing docstring in public function
tests/data_store/test_local_store.py:18 in public function `local_data_store`:
        D103: Missing docstring in public function
tests/data_store/test_local_store.py:34 in public class `TestLocalDataStore`:
        D101: Missing docstring in public class
tests/data_store/test_local_store.py:36 in public method `test_get_name`:
        D102: Missing docstring in public method
tests/data_store/test_local_store.py:39 in public method `test_read_generic_file`:
        D102: Missing docstring in public method
tests/data_store/test_local_store.py:44 in public method `test_read_json_file`:
        D102: Missing docstring in public method
tests/data_store/test_local_store.py:50 in public method `test_load_matlab_multi_matrix`:
        D102: Missing docstring in public method
tests/data_store/test_local_store.py:56 in public method `test_read_yaml_file`:
        D102: Missing docstring in public method
tests/data_store/test_local_store.py:64 in public method `test_read_pickle_file`:
        D102: Missing docstring in public method
10
    Fail
tests/utils/test_helper.py
tests/utils/test_helper.py:1 at module level:
        D100: Missing docstring in public module
tests/utils/test_helper.py:5 in public function `test_get_github_repo_info`:
        D103: Missing docstring in public function
tests/utils/test_helper.py:20 in public function `test_get_training_file_url`:
        D103: Missing docstring in public function
tests/utils/test_helper.py:37 in public function `test_load_hyper_params`:
        D103: Missing docstring in public function
4
    Fail
tests/utils/test_validation.py
tests/utils/test_validation.py:1 at module level:
        D100: Missing docstring in public module
tests/utils/test_validation.py:5 in public function `test_check_field_exists`:
        D103: Missing docstring in public function
tests/utils/test_validation.py:18 in public function `test_check_url_alive`:
        D103: Missing docstring in public function
3
    Fail
tests/deployments/emr_scripts/test_emr_script_builder.py
tests/deployments/emr_scripts/test_emr_script_builder.py:1 at module level:
        D100: Missing docstring in public module
tests/deployments/emr_scripts/test_emr_script_builder.py:12 in public class `TestEMRScriptBuilder`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_emr_script_builder.py:14 in public method `test_curr_time`:
        D102: Missing docstring in public method
tests/deployments/emr_scripts/test_emr_script_builder.py:19 in public method `test_construct_job_without_required_params`:
        D102: Missing docstring in public method
tests/deployments/emr_scripts/test_emr_script_builder.py:36 in public method `test_construct_job`:
        D102: Missing docstring in public method
5
    Fail
tests/deployments/emr_scripts/test_pypi_emr.py
tests/deployments/emr_scripts/test_pypi_emr.py:1 at module level:
        D100: Missing docstring in public module
tests/deployments/emr_scripts/test_pypi_emr.py:6 in public class `MockEMRConfig`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_pypi_emr.py:7 in public method `__init__`:
        D107: Missing docstring in __init__
tests/deployments/emr_scripts/test_pypi_emr.py:10 in public method `get_config`:
        D102: Missing docstring in public method
tests/deployments/emr_scripts/test_pypi_emr.py:26 in public class `TestPyPiEMR`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_pypi_emr.py:32 in public method `test_run_job`:
        D102: Missing docstring in public method
6
    Fail
tests/deployments/emr_scripts/test_npm_emr.py
tests/deployments/emr_scripts/test_npm_emr.py:1 at module level:
        D100: Missing docstring in public module
tests/deployments/emr_scripts/test_npm_emr.py:6 in public class `MockEMRConfig`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_npm_emr.py:7 in public method `__init__`:
        D107: Missing docstring in __init__
tests/deployments/emr_scripts/test_npm_emr.py:10 in public method `get_config`:
        D102: Missing docstring in public method
tests/deployments/emr_scripts/test_npm_emr.py:26 in public class `TestNpmEMR`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_npm_emr.py:32 in public method `test_run_job`:
        D102: Missing docstring in public method
6
    Fail
tests/deployments/emr_scripts/test_emr_config.py
tests/deployments/emr_scripts/test_emr_config.py:1 at module level:
        D100: Missing docstring in public module
tests/deployments/emr_scripts/test_emr_config.py:4 in public class `TestEMRConfig`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_emr_config.py:6 in public method `test_get_config`:
        D102: Missing docstring in public method
3
    Fail
tests/deployments/emr_scripts/test_maven_emr.py
tests/deployments/emr_scripts/test_maven_emr.py:1 at module level:
        D100: Missing docstring in public module
tests/deployments/emr_scripts/test_maven_emr.py:6 in public class `MockEMRConfig`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_maven_emr.py:7 in public method `__init__`:
        D107: Missing docstring in __init__
tests/deployments/emr_scripts/test_maven_emr.py:10 in public method `get_config`:
        D102: Missing docstring in public method
tests/deployments/emr_scripts/test_maven_emr.py:26 in public class `TestMavenEMR`:
        D101: Missing docstring in public class
tests/deployments/emr_scripts/test_maven_emr.py:32 in public method `test_run_job`:
        D102: Missing docstring in public method
@tisnik tisnik added the bug Something isn't working label Mar 8, 2019
@tisnik tisnik self-assigned this Mar 8, 2019
@tisnik tisnik removed their assignment Jan 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tisnik