Skip to content

docs: list every shape and control helper in place of add_shape/add_control - #444

Merged
airmang merged 2 commits into
mainfrom
docs/list-the-full-shape-helpers
Oct 8, 2026
Merged

airmang merged 2 commits into
mainfrom
docs/list-the-full-shape-helpers

Conversation

@airmang

@airmang airmang commented Oct 8, 2026 •

Copy link
Copy Markdown
Owner

바뀐 점

README의 "알려진 제약"과 API 참조가 도형 전용 메서드 중 선·사각형·타원만 안내하던 것을, 지금 있는 메서드 전부로 고친다.

  • README.md: add_shape() / add_control() 대신 쓸 메서드로 add_line() / add_rectangle() / add_ellipse() / add_arc() / add_polygon() / add_curve() / add_connector() / add_container()(묶음)와 컨트롤용 add_column_definition() / add_bookmark() / add_hyperlink()를 적는다.
  • README_EN.md: Known limitations에 같은 목록을 영어로 적는다.
  • docs/api_reference.md: HwpxOxmlParagraph의 도형 메서드 목록에 호·다각형·곡선·연결선·묶음을 더한다.
  • docs/python-example-ledger.json: README.md·README_EN.md의 고정 해시(manualSha256)를 새 내용으로 바꾼다. 두 README의 코드 블록은 그대로다.

Refs #51 — 이 이슈의 목표(한/글이 여는 완전한 개체 XML)는 위 전용 메서드들이 채운다. add_shape() / add_control()(6.0부터 doc.shapes.add_raw / doc.shapes.add_control)은 일부러 남긴 저수준 탈출구로, 하위 요소가 빠지면 경고한다(tests/test_shape_geometry_contract.py).

테스트

  • tests/test_documentation_code_fences.py의 원장 검사가 새 해시로 통과한다.
  • tests/test_contract_docs_sync.py, tests/test_stable_surface.py 통과.

🤖 Generated with Claude Code

…ontrol

The README's known limits and the API reference named only the line,
rectangle and ellipse helpers as the way past the low-level add_shape()
and add_control(). List the arc, polygon, curve, connector and container
helpers too, and the column definition, bookmark and hyperlink controls.

Refs #51

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@airmang

airmang commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

리뷰 결과: 머지 전에 하나만.

  • README_EN.md의 같은 항목(Known limitations, 177~179줄)이 아직 add_line() / add_rectangle() / add_ellipse()만 적습니다. 한국어 README와 같은 목록(add_arc() / add_polygon() / add_curve() / add_connector() / add_container(), 컨트롤 add_column_definition() / add_bookmark() / add_hyperlink())으로 맞추고, 예제 원장의 README_EN.md 해시도 커밋된 내용(LF)으로 바꿔 주세요.

확인한 것: 나열한 메서드는 모두 문단(HwpxOxmlParagraph)에 있고, 도형 쪽은 doc.shapes에도 있습니다. README.md의 원장 해시는 커밋된 내용과 같고 CR이 없습니다.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@airmang

airmang commented Oct 8, 2026

Copy link
Copy Markdown
Owner Author

다시 리뷰: 병합합니다. ef8f9de4로 README_EN.md의 Known limitations도 같은 목록(도형 8, 컨트롤 3)이 되었고, 예제 원장의 두 README 해시가 커밋된 내용(LF)과 같습니다.

@airmang
airmang merged commit 01a7c5d into main Oct 8, 2026
13 checks passed
@airmang
airmang deleted the docs/list-the-full-shape-helpers branch October 8, 2026 12:18
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

Successfully merging this pull request may close these issues.

1 participant