aws-cqc / aws-cqc/DeviceLayout.jl

Missing docstrings

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
67
Forks
14
Avg merge
1d 16h
Merged PRs (30d)
21

Description

If we don't run `makedocs` with `checkdocs=:none`, Documenter complains that we have many docstrings that don't appear in the docs. Not all of these are meant to be part of the public interface, but some do belong in the documentation, if only in a reference / developer docs (#1) section. Here's the full list as of v1.0.0:

```
┌ Error: 132 docstrings not included in the manual:

│ DeviceLayout.Paths.GeneralOffset
│ CoordinateTransformations.LinearMap
│ DeviceLayout.SchematicDrivenLayout.subcomponents :: Tuple{DeviceLayout.SchematicDrivenLayout.AbstractCompositeComponent}
│ DeviceLayout.Curvilinear.pathtopolys :: Union{Tuple{T}, Tuple{DeviceLayout.Paths.Segment{T}, DeviceLayout.Paths.Style}} where T
│ DeviceLayout.Polygons.ishole :: Tuple{Polygon}
│ DeviceLayout.PolyText.Style
│ DeviceLayout.SolidModels.staple_bridge_postrendering :: Tuple{}
│ DeviceLayout.Polygons.Circle :: Union{Tuple{T}, Tuple{Point{T}, T}} where T
│ DeviceLayout.Paths.change_handedness! :: Tuple{DeviceLayout.Paths.BSpline}
│ DeviceLayout.Polygons.getkey :: Tuple{Clipper.PolyNode}
│ DeviceLayout.Paths.undecorate! :: Tuple{DeviceLayout.Paths.DecoratedStyle, Any}
│ DeviceLayout.Transformations.affine :: Tuple{ScaledIsometry}
│ DeviceLayout.Paths.bellow :: Tuple{Point, Any, Any, DeviceLayout.Paths.Style}
│ CoordinateTransformations.recenter :: Tuple{Transformation, AbstractVector}
│ DeviceLayout.Polygons.rounded_corner :: Union{Tuple{S}, Tuple{T}, Tuple{Point{T}, Point{T}, Point{T}, S}} where {T, S<:Union{Real, Unitful.Level{L, S, Unitful.Quantity{T, 𝐋, U}} where {T, U, L, S }, Unitful.Quantity{T, 𝐋} where T}}
│ DeviceLayout.Intersect.crossing_gap :: Tuple{DeviceLayout.Intersect.IntersectStyle}
│ DeviceLayout.GDS.gdswrite :: Tuple{IO, Cell, Union{Unitful.Quantity{T, 𝐋, U}, Unitful.Level{L, S, Unitful.Quantity{T, 𝐋, U}} where {L, S}} where {T, U}}
│ DeviceLayout.GDS.gdswrite :: Union{Tuple{T}, Tuple{IO, Polygon{T}, Any, Any}} where T
│ DeviceLayout.GDS.gdswrite :: Tuple{IO, CellArray, Any}
│ DeviceLayout.GDS.gdswrite :: Tuple{IO, DeviceLayout.Texts.Text, Any, Any}
│ DeviceLayout.GDS.gdswrite :: Tuple{IO, CellReference, Any}
│ DeviceLayout.Paths.width
│ DeviceLayout.SolidModels.reindex_physical_groups! :: Tuple{SolidModel}
│ DeviceLayout.Curvilinear.CurvilinearRegion
│ CoordinateTransformations.CylindricalFromSpherical
│ CoordinateTransformations.AbstractAffineMap
│ DeviceLayout._geometry! :: Tuple{CoordinateSystem, DeviceLayout.AbstractComponent}
│ Base.inv :: Tuple{Transformation}
│ CoordinateTransformations.Transformation
│ DeviceLayout.GDS.GDS64
│ DeviceLayout.orientation :: Tuple{Point, Point, Point}
│ DeviceLayout.orientation :: Tuple{Polygon}
│ DeviceLayout.Paths.reconcilefields! :: Tuple{DeviceLayout.Paths.Node}
│ CoordinateTransformations.kabsch :: Union{Tuple{Pair{<:AbstractMatrix, <:AbstractMatrix}}, Tuple{Pair{<:AbstractMatrix, <:AbstractMatrix}, AbstractVector}}
│ DeviceLayout.SchematicDrivenLayout.ExamplePDK.tap! :: Union{Tuple{Path}, Tuple{Path, DeviceLayout.Paths.SimpleCPW}}
│ DeviceLayout.cpw_points :: Union{Tuple{Any, Any}, Tuple{Any, Any, Any}}
│ DeviceLayout.Polygons.segmentize :: Union{Tuple{Any}, Tuple{Any, Any}}
│ DeviceLayout.Polygons._round_poly :: Union{Tuple{S}, Tuple{T}, Tuple{DeviceLayout.AbstractPolygon{T}, S}} where {T, S<:Union{Real, Unitful.Level{L, S, Unitful.Quantity{T, 𝐋, U}} where {T, U, L, S }, Unitful.Quantity{T, 𝐋} where T}}
│ DeviceLayout.SchematicDrivenLayout.ExamplePDK.bridge_geometry :: Tuple{DeviceLayout.Paths.SimpleCPW}
│ CoordinateTransformations.transform_deriv_params :: Tuple{Transformation, Any}
│ DeviceLayout.Polygons.Ray
│ DeviceLayout.Align.AlignRule
│ DeviceLayout.Polygons.circularequality :: Tuple{Any, Any}
│ DeviceLayout.GDS.GDSFloat
│ DeviceLayout.SchematicDrivenLayout.ExamplePDK.filter_params :: Tuple{Any, Any}
│ DeviceLayout.Align._is_alignable :: Tuple{DeviceLayout.Align.RectAlignRule, DeviceLayout.Align.RectAlignRule}
│ DeviceLayout.Polygons.uniqueray :: Union{Tuple{Array{Point{T}, 1}}, Tuple{T}} where T<:Real
│ DeviceLayout.Paths.ConstantOffset
│ CoordinateTransformations.transform_deriv :: Tuple{Transformation, Any}
│ DeviceLayout.Intersect.prepared_intersections :: Tuple{Any}
│ DeviceLayout.Paths.CPWOpenTermination
│ DeviceLayout.Polygons.intersects :: Tuple{Point, DeviceLayout.Polygons.Ray}
│ DeviceLayout.Polygons.intersects :: Tuple{Point, DeviceLayout.Polygons.LineSegment}
│ DeviceLayout.Polygons.intersects :: Tuple{DeviceLayout.Polygons.LineSegment, DeviceLayout.Polygons.LineSegment}
│ DeviceLayout.Paths.pathlength_nearest :: Union{Tuple{T}, Tuple{DeviceLayout.Paths.Segment{T}, Point}} where T
│ Interpolations.prefiltering_system :: Union{Tuple{TC}, Tuple{T}, Tuple{Type{T}, Type{TC}, Int64, Interpolations.Cubic{DeviceLayout.Paths.NeumannBC{Interpolations.OnGrid}}}} where {T, TC}
│ Base.setindex! :: Tuple{SolidModel, Any, String}
│ DeviceLayout.SolidModels.dimgroupdict :: Tuple{SolidModel, Integer}
│ DeviceLayout.Paths.CPWShortTermination
│ CoordinateTransformations.CylindricalFromCartesian
│ DeviceLayout.Paths.makegrid :: Union{Tuple{T}, Tuple{AbstractVector{T}, Any}} where T<:DeviceLayout.Paths.Segment
│ DeviceLayout.Paths.line_segments :: Union{Tuple{Path{T}}, Tuple{T}} where T
│ DeviceLayout.Paths.line_segments :: Tuple{DeviceLayout.Paths.Segment}
│ DeviceLayout.Paths.line_segments :: Tuple{DeviceLayout.Paths.Straight}
│ CoordinateTransformations.cameramap :: Tuple{}
│ CoordinateTransformations.CartesianFromCylindrical
│ DeviceLayout.Intersect.intersect_pairwise! :: Tuple{DeviceLayout.Intersect.IntersectStyle, Path, Int64, Any, Path, Int64, Any}
│ DeviceLayout.SchematicDrivenLayout.ExamplePDK
│ DeviceLayout.Polygons.in_bounds :: Tuple{Point, DeviceLayout.Polygons.Ray}
│ DeviceLayout.Polygons.in_bounds :: Tuple{Point, DeviceLayout.Polygons.LineSegment}
│ CoordinateTransformations.IdentityTransformation
│ DeviceLayout.Polygons.LineSegment
│ DeviceLayout.SchematicDrivenLayout.SchematicLogger
│ DeviceLayout.Curvilinear.CurvilinearPolygon
│ DeviceLayout.Intersect.segment_tree :: Union{Tuple{Vararg{Path{T}}}, Tuple{T}} where T
│ DeviceLayout.Polygons.Ellipse
│ DeviceLayout.Cells.layers :: Tuple{Cell}
│ Base.get :: Tuple{SolidModel, Any, Any, DeviceLayout.SolidModels.AbstractPhysicalGroup}
│ CoordinateTransformations.SphericalFromCylindrical
│ CoordinateTransformations.ComposedTransformation
│ DeviceLayout.Polygons.circularapprox :: Tuple{Any, Any}
│ DeviceLayout.Intersect.intersection :: Tuple{DeviceLayout.Intersect.AirBridge, DeviceLayout.Paths.Style, Any}
│ DeviceLayout.Paths.SimpleTraceCorner
│ DeviceLayout.discretize_curve :: Tuple{Any, Any, Any}
│ DeviceLayout.Cells.CellRef
│ DeviceLayout.CoordinateUnits
│ DeviceLayout.Polygons.interiorcuts :: Union{Tuple{T}, Tuple{Clipper.PolyNode, Array{Polygon{T}, 1}}} where T
│ DeviceLayout.SchematicDrivenLayout.add_graph! :: Tuple{DeviceLayout.SchematicDrivenLayout.SchematicGraph, DeviceLayout.SchematicDrivenLayout.SchematicGraph}
│ DeviceLayout.Align._get_coord :: Tuple{DeviceLayout.AbstractGeometry, DeviceLayout.Align.AlignRule}
│ CoordinateTransformations.AffineMap :: Tuple{Transformation, Any}
│ CoordinateTransformations.AffineMap
│ CoordinateTransformations.AffineMap :: Tuple{Pair}
│ DeviceLayout.GDS.strans :: Tuple{IO, Any}
│ DeviceLayout.Paths.TraceTermination
│ DeviceLayout.Intersect.intersect_segment_tree :: Union{Tuple{T}, Tuple{IntervalTrees.IntervalBTree{T, IntervalTrees.IntervalValue{T, Tuple{Int64, Int64, DeviceLayout.Polygons.LineSegment{T}}}, 64}, IntervalTrees.IntervalBTree{T, IntervalTrees.IntervalValue{T, Tuple{Int64, Int64, DeviceLayout.Polygons.LineSegment{T}}}, 64}}} where T
│ DeviceLayout.Paths.OffsetSegment
│ DeviceLayout.Paths.bellow! :: Tuple{Path, Point, Any, Any}
│ DeviceLayout.Polygons.addstyle! :: Tuple{StyleDict, DeviceLayout.GeometryEntityStyle, Vector{Int64}}
│ Base.bswap :: Tuple{DeviceLayout.GDS.GDS64}
│ DeviceLayout.Paths.extent
│ DeviceLayout.SolidModels.bounds3d :: Tuple{DeviceLayout.SolidModels.AbstractPhysicalGroup}
│ DeviceLayout.Polygons.circle :: Union{Tuple{Any}, Tuple{Any, Any}}
│ CoordinateTransformations.PerspectiveMap
│ DeviceLayout.Align._disp :: Union{Tuple{T}, Tuple{S}, Tuple{DeviceLayout.AbstractGeometry{T}, DeviceLayout.AbstractGeometry{S}, DeviceLayout.Align.XAlignRule, DeviceLayout.Align.XAlignRule}} where {S, T}
│ DeviceLayout.Paths.transformappend :: Tuple{Path, Point}
│ CoordinateTransformations.PolarFromCartesian
│ DeviceLayout.Paths._route! :: Tuple{Path, Point, Any, DeviceLayout.Paths.RouteRule, Any, Any, Any}
│ CoordinateTransformations.CartesianFromSpherical
│ Base.read :: Tuple{IO, Type{DeviceLayout.GDS.GDS64}}
│ DeviceLayout.Polygons.intersects_at_endpoint :: Tuple{DeviceLayout.Polygons.LineSegment, DeviceLayout.Polygons.LineSegment}
│ DeviceLayout.layer_included :: Tuple{DeviceLayout.Meta, Any, Any}
│ DeviceLayout.SolidModels.hasgroup :: Tuple{SolidModel, String, Integer}
│ DeviceLayout.GDS.even :: Tuple{Any}
│ DeviceLayout.Paths.reconcilestart! :: Union{Tuple{DeviceLayout.Paths.Node{T}}, Tuple{T}, Tuple{DeviceLayout.Paths.Node{T}, Any}, Tuple{DeviceLayout.Paths.Node{T}, Any, Any}} where T
│ CoordinateTransformations.Polar
│ CoordinateTransformations.Polar :: Tuple{AbstractVector}
│ DeviceLayout.Paths.curvature :: Tuple{Any, Any}
│ DeviceLayout.Paths.OverlayStyle
│ DeviceLayout.Paths.radiator :: Tuple{Point, Any, Int64, Any, DeviceLayout.Paths.Style}
│ DeviceLayout.Paths.reconcilelinkedlist! :: Tuple{Path, Integer}
│ Unitful.ustrip :: Union{Tuple{Point{T}}, Tuple{T}} where T
│ CoordinateTransformations.Spherical
│ DeviceLayout.SolidModels.attributes :: Tuple{SolidModel}
│ CoordinateTransformations.SphericalFromCartesian
│ DeviceLayout.Paths._update_interpolation! :: Tuple{DeviceLayout.Paths.BSpline}
│ DeviceLayout.ArrayEntity
│ CoordinateTransformations.Cylindrical
│ Base.write :: Tuple{IO, DeviceLayout.GDS.GDS64}
│ DeviceLayout.Paths.discretization :: Tuple{DeviceLayout.Paths.Segment}
│ Base.round :: Union{Tuple{T}, Tuple{Type{T}, Point}, Tuple{Type{T}, Point, RoundingMode}} where T<:Number
│ Base.bitstring :: Tuple{DeviceLayout.GDS.GDS64}
│ CoordinateTransformations.CartesianFromPolar

│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in canonical @docs or @autodocs blocks.
```

Contributor guide

Open the contributing guide

Research direction

Start by running the `makedocs` check and reviewing the 132-item list of docstrings reported by Documenter. For each entry, determine whether it belongs in canonical `@docs`/`@autodocs` blocks or a reference/developer docs section, then verify that `makedocs` reports no remaining intended public documentation gaps.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.