aws-cqc / aws-cqc/DeviceLayout.jl

Document style handling for 2D booleans and other methods

Closed
#318 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
67
Forks
14
Avg merge
1d 19h
Merged PRs (30d)
24

Description

Applying a boolean operation to a `MeshSized` entity returns a bare `ClippedPolygon` (or `CurvilinearRegion` for the `_curved` variants) with no sizing information and no warning. Transforms (`translate`, `rotate`, `Reflection`, …) preserve the style, so users might reasonably expect booleans to as well — the style is an annotation, not geometry.

Similarly, `OptionalStyle` is resolved to its default, `Rounded` is discretized by non-curved variants, `ToTolerance` discretizes curves even in `_curved` variants.

`offset` and `halo` are similar.

This should all be documented. We could also consider preserving the style when unambiguous.

Contributor guide

Open the contributing guide

Research direction

Locate the documentation entry points for 2D booleans, their _curved variants, offset, halo, and transforms. Document the observed handling of MeshSized, OptionalStyle, Rounded, and ToTolerance styles, including when curves are discretized or sizing information is lost. Done means users can find and understand these behaviors and the possible style-preservation consideration.

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
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.