efabless / openlane2

The next generation of OpenLane, rewritten from scratch with a modular architecture
https://openlane2.readthedocs.io/
Apache License 2.0
168 stars 30 forks source link

Two bullet points not rendered as bullet points in documentation #497

Open jeras opened 4 days ago

jeras commented 4 days ago

Sorry for the trivial issue.

In the source code: https://github.com/efabless/openlane2/blob/bc143861bdd1fe22169a73054bcb3207fc3ce3f0/openlane/flows/flow.py#L513

In documentation: https://openlane2.readthedocs.io/en/latest/reference/api/flows/index.html#openlane.flows.Flow.start

jeras commented 4 days ago

Another trivial one, a broken wikipedia link in the same source file: https://github.com/efabless/openlane2/blob/bc143861bdd1fe22169a73054bcb3207fc3ce3f0/openlane/flows/flow.py#L939

In documentation the link is missing the closing parenthesis is missing from the link: https://openlane2.readthedocs.io/en/latest/reference/api/flows/index.html#openlane.flows.Flow.FlowFactory

jeras commented 4 days ago

Another bullet point issue: https://github.com/efabless/openlane2/blob/bc143861bdd1fe22169a73054bcb3207fc3ce3f0/openlane/flows/cli.py#L198 https://openlane2.readthedocs.io/en/latest/reference/api/flows/index.html#openlane.flows.cloup_flow_opts

donn commented 4 days ago

Never apologize for being helpful. Thank you. We'll be looking into these.