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.

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

docstrings in the code not published in the documentation #118

Open
mithro opened this issue Jun 3, 2022 · 0 comments
Open

docstrings in the code not published in the documentation #118

mithro opened this issue Jun 3, 2022 · 0 comments

Comments

@mithro
Copy link
Collaborator

mithro commented Jun 3, 2022

See docstrings in file https://github.com/chipsalliance/f4pga-v2x/blob/main/v2x/yosys/run.py for example;

f4pga-v2x/v2x/yosys/run.py

Lines 158 to 178 in 413dc27

def add_define(defname):
"""Add a Verilog define to the list of defines to set in Yosys"""
defines.append(defname)
def get_defines():
"""Return a list of set Verilog defines, as a list of arguments
to pass to Yosys `read_verilog`"""
return " ".join(["-D" + _ for _ in defines])
def add_include(path):
""" Add a path to search when reading verilog to the list of
includes set in Yosys"""
includes.append(path)
def get_includes():
"""Return a list of include directories, as a list of arguments
to pass to Yosys `read_verilog`"""
return " ".join(["-I" + _ for _ in includes])

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant