Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve/Augment examples #590

Open
mwestphal opened this issue Jan 31, 2023 · 6 comments
Open

Improve/Augment examples #590

mwestphal opened this issue Jan 31, 2023 · 6 comments
Labels
help wanted Please help with this issue! source:libf3d source:python type:enhancement New feature or request
Milestone

Comments

@mwestphal
Copy link
Contributor

mwestphal commented Jan 31, 2023

Context
F3D also contains the libf3d, a C++ library with different bindings.
We currently provide a few examples in C++ and python.
F3D also automatize the building and testing of C++ example, which are validated in CI.
These examples should be augmented, ported and shared.

Suggested improvements

  • Add more C++ examples
  • Port C++ examples to other bindings : needs bindings stability first
  • Add automated testing of the python examples
  • Display (C++, python) examples in the website
@mwestphal mwestphal added type:enhancement New feature or request good first issue Good for newcomers labels Jan 31, 2023
@mwestphal mwestphal added this to the 2.0.0 milestone Jan 31, 2023
@mwestphal mwestphal modified the milestones: 2.0.0, 2.1.0 Mar 28, 2023
@mwestphal mwestphal modified the milestones: 2.1.0, 2.2.0 Jun 18, 2023
@mwestphal
Copy link
Contributor Author

Adding python example should also be considered

@Ni-g-3l
Copy link
Contributor

Ni-g-3l commented Dec 17, 2023

Hey I'm currently playing with python bindings. And I miss a lot some example to understand how it works exactly.

I'm trying to reproduce actual CPP examples in python (I can put it in a PR if you want). But it's very slow because I miss Python API documentation like class, methods, and attribute (like Read the docs or Furo). May be we could try to add python API doc generated by sphinx to actual F3D documentation (in Bindings section).

And then what kind of example would you add ? (may be I can add it to the PR too in both Python and CPP)

@mwestphal
Copy link
Contributor Author

May be we could try to add python API doc generated by sphinx to actual F3D documentation (in Bindings section).

Definitely! If you want to work on that you'd be very welcome! You can look at the python tests, its the best we have as a documentation for now.

And then what kind of example would you add ?

Anything really, copying the C++ examples would be a start

@mwestphal mwestphal modified the milestones: 2.3.0, 2.4.0 Dec 21, 2023
@mwestphal mwestphal added the help wanted Please help with this issue! label Jan 7, 2024
@mwestphal
Copy link
Contributor Author

Python examples have been added, Ill update the issue to have a more coherent plan for examples in general.

@mwestphal mwestphal added help wanted Please help with this issue! and removed good first issue Good for newcomers help wanted Please help with this issue! labels Jan 17, 2024
@mwestphal
Copy link
Contributor Author

@snoyer @Meakk : please provide more ideas and concrete solutions :)

@Meakk Meakk added this to F3D Feb 2, 2024
@mwestphal mwestphal modified the milestone: 2.4.0 Feb 3, 2024
@mwestphal mwestphal moved this to To do in F3D Feb 4, 2024
@mwestphal mwestphal removed this from the 2.4.0 milestone Apr 4, 2024
@mwestphal mwestphal added this to the 2.5.0 milestone Apr 4, 2024
@mwestphal mwestphal modified the milestones: 2.5.0, 3.0.0 Jul 3, 2024
@mwestphal mwestphal modified the milestones: 3.0.0, 3.1.0 Jul 13, 2024
@mwestphal
Copy link
Contributor Author

Examples are more and more outdated, setting to improve for 3.0 if possible

@mwestphal mwestphal modified the milestones: 3.1.0, 3.0.0 Dec 16, 2024
@Meakk Meakk assigned Meakk and unassigned Meakk Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please help with this issue! source:libf3d source:python type:enhancement New feature or request
Projects
Status: To do
Development

No branches or pull requests

3 participants