f3d icon indicating copy to clipboard operation
f3d copied to clipboard

fix: improve help(f3d)

Open carsonRadtke opened this issue 6 months ago • 4 comments

Describe your changes

  • Removes the CMake stub from the help message
  • Removes the private exported constants from the help message
  • Adds all the pyf3d exports to the help message

Issue ticket number and link if any

Fixes: https://github.com/f3d-app/f3d/issues/1019

Checklist for finalizing the PR

  • [x] I have performed a self-review of my code
  • [ ] I have added tests for new features and bugfixes
  • [ ] I have added documentation for new features
  • [ ] If it is a modifying the libf3d API, I have updated bindings
  • [ ] If it is a modifying the .github/workflows/versions.json, I have updated timestamp

Continuous integration

Please check the checkbox of the CI you want to run, then push again on your branch.

  • [x] Style checks
  • [x] Fast CI
  • [x] Coverage cached CI
  • [x] Analysis cached CI
  • [x] WASM docker CI
  • [x] Android docker CI
  • [x] macOS Intel cached CI
  • [x] macOS ARM cached CI
  • [x] Windows cached CI
  • [x] Linux cached CI
  • [x] Other cached CI

carsonRadtke avatar Jun 16 '25 05:06 carsonRadtke

The new help message looks like: f3d.help.txt

carsonRadtke avatar Jun 16 '25 05:06 carsonRadtke

@snoyer can you take a look?

Meakk avatar Jun 16 '25 05:06 Meakk

It definitely looks much better, but indeed needs a @snoyer review :)

mwestphal avatar Jun 16 '25 06:06 mwestphal

@carsonRadtke please push again, I've enabled CI :)

mwestphal avatar Jun 16 '25 14:06 mwestphal