aws-cqc / aws-cqc/DeviceLayout.jl
Document decoration of schematic routes
- Dominant language
- Julia
- Stars
- 67
- Forks
- 14
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 21
Description
It's mentioned in the [schematic FAQ](https://aws-cqc.github.io/DeviceLayout.jl/stable/schematicdriven/faq/) and used inside `add_bridges!` in ExamplePDK, but there's no docstring for `attach!(::RouteComponent, ...)`, and especially no mention of gotchas with respect to route initialization in `plan` and path construction in `build!` (or `SchematicDrivenLayout.path`, which is also undocumented)
Contributor guide
Research direction
Start with the schematic FAQ and the add_bridges! usage in ExamplePDK, then trace attach!(::RouteComponent, ...), route initialization in plan, and path construction in build! and SchematicDrivenLayout.path. Done when the relevant docstrings explain these APIs and their route-initialization and path-construction gotchas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100