documentation styles

You can choose different ways of documenting the help section of your code.

Those are adapted from their equivalent in python.

Those functions can be found here

—

src.count_line_google_style_help(file, line)

Counts the number of times a line occurs. Case-sensitive. White space padding are ignored.

USAGE:

num_instances = count_line_google_style_help(file, line)

Arguments:

file (cellstr): content of file to scan

line (char): the line to count

Returns:

num_instances (int): the number of times the line occurs.

—

src.count_line_numpy_style_help(file, line)

Counts the number of times a line occurs. Case-sensitive. White space padding are ignored.

USAGE:

num_instances = count_line_google_style_help(file, line)

Parameters

file: cellstr

content of file to scan

line: char

the line to count

Returns

num_instances: int

the number of times the line occurs.

—

src.count_line_rst_style_help(file, line)

Counts the number of times a line occurs. Case-sensitive. White space padding are ignored.

USAGE:

num_instances = count_line_google_style_help(file, line)

Parameters:

• file – content of file to scan

• line – the line to count

Returns:

• num_instances:

  (int) the number of times the line occurs.