Skip to content

Commit b1f81da

Browse files
committed
Add reports for April
- Improve C++ API documentation - Improve User Experience VarSets - OCCT liaison
1 parent 90b4c81 commit b1f81da

File tree

3 files changed

+159
-0
lines changed

3 files changed

+159
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Summary of Activities - Improve C++ API Documentation - April 2025
2+
3+
### CMake issues for generating documentation
4+
5+
Last month, I created the PR below which was still open. This has been merged
6+
now and needed some fixing as well.
7+
8+
- [#20479 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20479)
9+
- [#20709 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20709)
10+
11+
### Fixing unassociated doc strings
12+
13+
Some doc strings were not associated with a specific piece of code and would
14+
appear randomly:
15+
16+
- [#20737 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20737)
17+
18+
### PropertyContainer
19+
20+
The documentation of PropertyContainer was improved. Based on community
21+
feedback on the forum, I changed the assignment of this project slightly. I
22+
defined the project as having the scope by just fixing the doc comments of
23+
classes, functions, etc. However, it was clear that the community wanted to
24+
have improved overview texts as well, that would provide developers context.
25+
So, I decided that I will not document all of the App package, but just the
26+
most important things but I will add overview texts as well. For this work, I
27+
created such an overview text for the Property Framework where the most
28+
important object is PropertyContainer. This came in two PRs:
29+
30+
- [#20781 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20781)
31+
- [#21065 (merged)](https://github.com/FreeCAD/FreeCAD/pull/21065)
32+
33+
### Discussion on how to document
34+
35+
Based on the above PR, a [discussion on
36+
Discord](https://discord.com/channels/870877411049357352/1354091480393842799)
37+
was started to establish how documentation can be done in FreeCAD. This can
38+
eventually lead to guidelines in the developer guide.
39+
40+
### Property
41+
42+
I've started working on improving the documentation of Property but this is not
43+
yet finished.
44+
45+
### ObjectIdentifier
46+
47+
The same is true for ObjectIdentifier.
48+
49+
50+
51+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Summary of Activities - VarSet User Experience - April 2025
2+
3+
### Update the project page
4+
5+
I've updated the [project page](https://github.com/orgs/FreeCAD/projects/30/views/1).
6+
7+
### Visibility icon for VarSet
8+
9+
Last month I couldn't find a satisfactory solution. This month I have:
10+
- [#20649 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20649)
11+
- [#20573 (closed)](https://github.com/FreeCAD/FreeCAD/pull/20573)
12+
13+
### Units in the VarSet dialog
14+
15+
Last month, I worked on units in the VarSet dialog, but I couldn't make them
16+
work properly. This month I have:
17+
- [#20570 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20570).
18+
19+
### Frame around the value field in the VarSet dialog
20+
21+
The value field lacked a frame. This has been fixed in:
22+
- [#20582 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20582)
23+
24+
### Immediate access to value field VarSet dialog
25+
26+
In the VarSet dialog, it was necessary to first define a name and type, and
27+
only then the value field would appear, leading to a strange user experience.
28+
This has been fixed in:
29+
30+
- [#20824 (merged)](https://github.com/FreeCAD/FreeCAD/pull/20824)
31+
32+
### Add multiple properties VarSet dialog
33+
34+
In [issue #20637](https://github.com/FreeCAD/FreeCAD/issues/20637) there are
35+
different opinions on how the user flow should be when adding multiple
36+
properties in the VarSet dialog. I started a discussion with the Design
37+
Working Group, but there does not seem to be much consensus either.
38+
39+
### Refactoring properties
40+
41+
A larger task in the project is allowing users to refactor properties in
42+
VarSets or other document objects. I've started thinking about how this should
43+
happen and the concrete action I'm now working on is renaming as I announced in
44+
[issue #16222](https://github.com/FreeCAD/FreeCAD/issues/16222).
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
## Summary of Activities - OCCT Liaison - April 2025
2+
3+
### Contact with Dmitrii: Data Exchange
4+
5+
In the last report, I wrote that this needed follow up, which I haven't done
6+
yet. I will do that in May.
7+
8+
### Discussion on OCCT bug reporting and versions
9+
10+
Last month, I wrote that this needed follow up and I did. Oursland writes this:
11+
12+
> It's not a genuine compatibility issue as some other build systems are using OCCT 7.9.0, but the conda-forge smesh still needs to be updated.
13+
14+
So, I'm waiting for that.
15+
16+
### Suggest a process for a 10 year roadmap
17+
18+
I've had a meeting with Brad in which we discussed the idea. I've also had a
19+
meeting with Hyarion and Kadet1090 on which I reported in the FPA meeting.
20+
Some interesting points that came out of this meeting:
21+
- It would be good if FreeCAD could work with a company that uses FreeCAD in industry.
22+
- It would be nice to have a label "AdoptionBlocker" similar to the "Blocker"
23+
label for 1.0. The new label indicates that these issues are blockers for
24+
widespread adoption of FreeCAD.
25+
- Idea from Kadet1090: make a document with 100 problems for the next 10 years.
26+
- Hold another meeting with a slightly larger group of people.
27+
28+
### Check forum on OCCT issues
29+
30+
I wrote last month that I wanted to participate on the forum. I announced
31+
myself there, but it was an old post. I haven't had any reactions.
32+
33+
### Update the project
34+
35+
The [OCCT Liaison project](https://github.com/orgs/FreeCAD/projects/32/views/1?layout=table) has
36+
received continuous updates on issues.
37+
38+
### Draw Test Harness
39+
40+
I've investigated creating Draw Test Harnesses. I studied the Draw Test
41+
Harness that bgbsww created in
42+
[#9760](https://github.com/FreeCAD/FreeCAD/issues/9760).
43+
44+
Given the results of this study, I focused my attention to
45+
[#10760](https://github.com/FreeCAD/FreeCAD/issues/10760), a fillet with a
46+
crash. I could confirm the crash. The process was:
47+
48+
- make a minimal example, finding out the (in this case) two features that cause the problem
49+
- make a Draw test case that mimics the minimal example
50+
- verify the stack traces to confirm that the test case is indeed the same problem
51+
- report it to OCCT ([#501](https://github.com/Open-Cascade-SAS/OCCT/issues/501).
52+
53+
Please note, that this was a fairly complicated test case to create.
54+
55+
### Part Design / Part interaction
56+
57+
I studied [#19702](https://github.com/FreeCAD/FreeCAD/issues/19702) and came to
58+
the conclusion that this may be an OCCT problem, but there is also a problem
59+
with the interaction between Part and Part Design.
60+
61+
I have created [#](https://github.com/FreeCAD/FreeCAD/issues/20735) for that
62+
problem and I have raised this in the DEV meeting of 19 April. Unfortunately,
63+
this was a meeting without many developers, so we could not make progress on
64+
this matter. I will put this back on the agenda at a next meeting.

0 commit comments

Comments
 (0)