Skip to content

Documentation - Fix typos, naming, and snippet bugs in user guides#1273

Merged
dpasukhi merged 1 commit into
Open-Cascade-SAS:IRfrom
dpasukhi:documentation-overview
May 6, 2026
Merged

Documentation - Fix typos, naming, and snippet bugs in user guides#1273
dpasukhi merged 1 commit into
Open-Cascade-SAS:IRfrom
dpasukhi:documentation-overview

Conversation

@dpasukhi

@dpasukhi dpasukhi commented May 6, 2026

Copy link
Copy Markdown
Member
  • Align example variable names with OCCT conventions; modernize macros and types (Handle -> occ::handle, NULL -> nullptr, PI -> M_PI, Standard_EXPORT casing).
  • Correct API and enum names across user guides (BOPTools_Tools -> BOPTools_AlgoTools, BOPAlgo_Glue -> BOPAlgo_GlueEnum, Geom_BSplineSurface, BRepPrimAPI_MakePrism, TransferOne, FindAttribute, BRepFeat_MakePrism int-Fuse signature).
  • Fix long-standing snippet bugs: GetClosedWires/GetOpenWires mix-up, inverted IsNull in xde, vertex dimension, missing IsDone() guards in tutorial, missing loop around Rake.Add, JSON syntax in debug, BNF brackets in brep_format, sphere latitude range, plus assorted typos.

@dpasukhi dpasukhi added this to the Release 8.0 milestone May 6, 2026
@dpasukhi dpasukhi added the 1. Documentation Improvements or additions to documentation label May 6, 2026
- Align example variable names with OCCT conventions; modernize
  macros and types (Handle -> occ::handle, NULL -> nullptr,
  PI -> M_PI, Standard_EXPORT casing).
- Correct API and enum names across user guides (BOPTools_Tools ->
  BOPTools_AlgoTools, BOPAlgo_Glue -> BOPAlgo_GlueEnum,
  Geom_BSplineSurface, BRepPrimAPI_MakePrism, TransferOne,
  FindAttribute, BRepFeat_MakePrism int-Fuse signature).
- Fix long-standing snippet bugs: GetClosedWires/GetOpenWires
  mix-up, inverted IsNull in xde, vertex dimension, missing
  IsDone() guards in tutorial, missing loop around Rake.Add,
  JSON syntax in debug, BNF brackets in brep_format, sphere
  latitude range, plus assorted typos.
@dpasukhi dpasukhi force-pushed the documentation-overview branch from b74f277 to 8806818 Compare May 6, 2026 21:59
@dpasukhi dpasukhi merged commit 1b9f9c6 into Open-Cascade-SAS:IR May 6, 2026
10 checks passed
@dpasukhi dpasukhi deleted the documentation-overview branch May 6, 2026 22:24
@github-project-automation github-project-automation Bot moved this from Todo to Done in Maintenance May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1. Documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant