View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0033753 | Open CASCADE | OCCT:Documentation | public | 2024-06-28 14:26 | 2024-07-02 14:51 |
| Reporter | astromko | Assigned To | dpasukhi | ||
| Priority | normal | Severity | minor | ||
| Status | resolved | Resolution | open | ||
| Product Version | 7.9.0 | ||||
| Target Version | 7.9.0 | ||||
| Summary | 0033753: Documentation - Updating Offset documentation | ||||
| Description | Expanding Offset documentation. | ||||
| Steps To Reproduce | Not needed. | ||||
| Tags | No tags attached. | ||||
| Test case number | |||||
|
|
Branch CR33753 has been created by astromko. SHA-1: 0abca55132cd74988f5e59837da3b3a83d131a4f Detailed log of new commits: Author: astromko Date: Fri Jun 28 12:33:29 2024 +0100 0033753: Updating OCCT documentation Added description and examples for offsetperform function. |
|
|
Dear astromko, There are a few language corrections I would like you to make (a few typos and non-ideal phrasing in some places). I am going to send you the proofread versions shortly; please update your commit with them. |
|
|
Branch CR33753 has been updated forcibly by astromko. SHA-1: a624c5edafe34d8067a31becc5c2ae75c3315693 |
|
|
Updated the commit with the proofread versions. |
|
|
Branch CR33753 has been updated forcibly by astromko. SHA-1: ca066529b7d2c0c16fea992690431ae859d70dd1 |
|
|
Please update git message. One moment, let me check the generate documentation, after that i will send to bugmaster after checking on generated html. |
|
|
“offsetperform“ function topic name has no common styl and name is not clear. Which function? This functon uses 2 algorithms presented It is not an article, it is documentation. Let’s consider the MakeOffsetShape method. Water. And you have no look into any details below. Let’s consider BuildOffsetByInter in detail. Looks like that you are copying from header. It is no looks like as a code sample. Methods has no object to be called from. Additionally, there are no common way in your update with ";" at the end or without.
MakeOffsetFaces(/*BRepOffset_DataMapOfShapeOffset&*/ theMapSF,
/*const Message_ProgressRange&*/ theRange)
Not correct style of variable names in code samples "OF", "Inter3" Needs to describe syntax at the first line and I recommend to split any related commands in different topics to describe them separately. offsetperform Creates a new figure by moving faces of an initial figure. Can move any number of faces. The offset direction is set by a positive or negative step value in the «offsetload» or «offsetonface» commands. Yes, this command not part of "offsetperform" command. Better to split and make it in common way avoid any misunderstanding. If you want to move all faces for example on step=2 you should specify it in the «offsetload» command like this: offsetload b 2 The «offsetonface» command is not needed in this case. |
|
|
Branch CR33753 has been updated by astromko. SHA-1: d79b8f6cce9bf992242cbd8e325a7886f26088b6 Detailed log of new commits: Author: astromko Date: Tue Jul 2 12:49:59 2024 +0100 0033753: Updating OCCT documentation Added description and an example for the "offsetperform", "offsetload", "offsetonface" functions in the "Draw Test Harness" section. Added description for "offsetperform" function in the "Modeling Algorithms" section. |
|
|
Corrected. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2024-06-28 14:26 | astromko | New Issue | |
| 2024-06-28 14:26 | astromko | Assigned To | => astromko |
| 2024-06-28 14:34 | git | Note Added: 0116084 | |
| 2024-06-28 14:40 | astromko | Assigned To | astromko => ebelouso |
| 2024-06-28 14:40 | astromko | Status | new => resolved |
| 2024-06-28 14:40 | astromko | Steps to Reproduce Updated | |
| 2024-07-01 14:24 | dpasukhi | Summary | Updating OCCT documentation => Documentation - Updating Offset documentation |
| 2024-07-01 14:45 | ebelouso | Note Added: 0116099 | |
| 2024-07-01 14:45 | ebelouso | Assigned To | ebelouso => astromko |
| 2024-07-01 14:46 | ebelouso | Status | resolved => assigned |
| 2024-07-01 15:35 | git | Note Added: 0116100 | |
| 2024-07-01 15:37 | astromko | Assigned To | astromko => ebelouso |
| 2024-07-01 15:37 | astromko | Status | assigned => resolved |
| 2024-07-01 15:37 | astromko | Note Added: 0116101 | |
| 2024-07-01 18:07 | git | Note Added: 0116102 | |
| 2024-07-01 18:16 | ebelouso | Assigned To | ebelouso => bugmaster |
| 2024-07-01 18:16 | ebelouso | Status | resolved => reviewed |
| 2024-07-02 11:43 | dpasukhi | Assigned To | bugmaster => astromko |
| 2024-07-02 11:43 | dpasukhi | Status | reviewed => assigned |
| 2024-07-02 11:43 | dpasukhi | Note Added: 0116103 | |
| 2024-07-02 12:45 | dpasukhi | Note Added: 0116104 | |
| 2024-07-02 14:50 | git | Note Added: 0116106 | |
| 2024-07-02 14:51 | astromko | Assigned To | astromko => dpasukhi |
| 2024-07-02 14:51 | astromko | Status | assigned => resolved |
| 2024-07-02 14:51 | astromko | Note Added: 0116107 |
