mylib module
Module for demonstrating integration of stardoc, bazel, readthedocs, and sphinx.
This modules is just an example for demonstration purposes
Example usage
load(":mylib.bzl", "rock_you")
lyrics = rock_you(False)
rock_you
rock_you(we, will, you)
Rocks your house
This is an example function with a doc string. It can make use of markdown
Note
You may experience a sensation of being rocked
Only rock out if you don’t have conditions such as:
Distain for rocking
Inability to rock
To use this, you call rock_you(), or here’s an example as a code block:
lyrics = rock_you(True)
Remember that the first value is a bool.
PARAMETERS
- we
(
bool) the arg with a long description of stuff that will have multiple lines of text and be very long, lets try to list some items:foo
bar
- will
(default
"rock") another arg with some documentation, it also usescodefontto and links to things likelist- you
(default
[]) (list) a last arg- RETURNS
strlyrics of an iconic song