DELL Technical Reference Guide

Generated by CapsLockHacks on 2018-04-20 09:08:41

Contents

1. C:\dev\hackathon\dell-hack\auto_docstring.py
2. C:\dev\hackathon\dell-hack\db_functions.py
3. C:\dev\hackathon\dell-hack\json_to_xml.py
4. C:\dev\hackathon\dell-hack\mongo_connection.py
5. C:\dev\hackathon\dell-hack\mysql_connection.py
6. C:\dev\hackathon\dell-hack\oracle_connection.py
7. C:\dev\hackathon\dell-hack\plugin.py
8. C:\dev\hackathon\dell-hack\postgres_connection.py
9. py2md.py - Simple docs generator for Python code documented to Google docstring standard.
10. C:\dev\hackathon\dell-hack\server.py
11. C:\dev\hackathon\dell-hack\test_function_for_docstrings.py
12. C:\dev\hackathon\dell-hack\xml_to_json.py

C:\dev\hackathon\dell-hack\auto_docstring.py

source file

find_all_declarations

find_all_declarations(view, include_module=False)

find_preceding_declaration

find_preceding_declaration(view, defs, region)

get_indentation

get_indentation(view, target, module_decl=False)

get_docstring

get_docstring(view, edit, target, default_qstyle=None, extra_class_newlines=True)

get_whole_block

get_whole_block(view, target)

find_all_in_region

find_all_in_region(view, reg, what, blacklist=None, flags=0)

get_all_blocks

get_all_blocks(view, reg, classes_only=False)

get_attr_type

get_attr_type(value, default_type, existing_type)

get_desired_style

get_desired_style(view, default="google", desire=None)

parse_function_params

parse_function_params(s, ret_annotation, default_type, default_description, optional_tag="optional")

parse_return_keyword

parse_return_keyword(view, target)

parse_function_exceptions

parse_function_exceptions(view, target, default_description)

parse_class_attributes

parse_class_attributes(view, target, default_type, default_description)

parse_module_attributes

parse_module_attributes(view, default_type, default_description)

snipify

snipify(_words, _use_snippet=False)

autodoc

autodoc(view, edit, region, all_defs, desired_style, file_type, default_qstyle=None, update_only=False)

is_python_file

is_python_file(view)

C:\dev\hackathon\dell-hack\db_functions.py

source file

db_functions

db_functions(tablename,databasename,intent)

getLastAccessDate

getLastAccessDate(tablename, conn)

getRiseinRows

getRiseinRows(tablename, conn)

getRows

getRows(tablename, conn)

C:\dev\hackathon\dell-hack\json_to_xml.py

source file

json2xml

json2xml(json_obj, line_padding="")

C:\dev\hackathon\dell-hack\mongo_connection.py

source file

C:\dev\hackathon\dell-hack\mysql_connection.py

source file

C:\dev\hackathon\dell-hack\oracle_connection.py

source file

C:\dev\hackathon\dell-hack\plugin.py

source file

send_data_to_server

send_data_to_server(data)

C:\dev\hackathon\dell-hack\postgres_connection.py

source file

py2md.py - Simple docs generator for Python code documented to Google docstring standard.

source file

extract_code

extract_code(end_mark, current_str, str_array, line_num)

Extract a multi-line string from a string array, up to a specified end marker.

        Args:
            end_mark (str): The end mark string to match for.
            current_str (str): The first line of the string array.
            str_array (list): An array of strings (lines).
            line_num (int): The current offset into the array.

        Returns:
            Extended string up to line with end marker.
    

process_file

process_file(pyfile_name)

Process a Python source file with Google style docstring comments.

    Reads file header comment, function definitions, function docstrings.
    Returns dictionary encapsulation for subsequent writing.

    Args:
        pyfile_name (str): file name to read.

    Returns:
        Dictionary object containing summary comment, with a list of entries for each function.
    

process_output

process_output(meta_file, outfile_name, code_links)

Create a markdown format documentation file.

    Args:
        meta_file (dict): Dictionary with documentation metadata.
        outfile_name (str): Markdown file to write to.
    

main

main()

Main routine.

C:\dev\hackathon\dell-hack\server.py

source file

escape_for_cmd_exe

escape_for_cmd_exe(arg)

alexa

alexa()

C:\dev\hackathon\dell-hack\test_function_for_docstrings.py

source file

hello

hello(a,b,c,d)

C:\dev\hackathon\dell-hack\xml_to_json.py

source file