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

[WikiObjectPropertiesListGenerator] Add object's properties code generator for Wiki #182

Merged
merged 4 commits into from
Nov 22, 2024

Conversation

hasecilu
Copy link
Contributor

@hasecilu hasecilu commented Nov 15, 2024

Replaces #181

Usage:

  • Create one object and don't change its default values.
  • Select the scripted object on the tree view and execute the macro.
  • Mark the checkbox if necessary (it prints "|Dynamic" on the user properties, but not really on use on Wiki pages) and choose the option for the properties you need on your article.
  • On the Report View you'll see printed text that you should copy on the Wiki page.

Forum post: https://forum.freecadweb.org/viewtopic.php?f=21&t=61998&start=20
Wiki: https://wiki.freecad.org/Macro_Wiki_Object_Properties_List_Generator

image


Thank you for creating a pull request to contribute to FreeCAD-macros!
To integrate your macro please make sure the following steps are complete:

  • Please check this box if you're not submitting a new macro.
  • Are you submitting a new macro ?
  • Have you followed the 'How to submit a macro' section of the README.md ?
  • Your macro has a Description in its header.
  • Your macro has a CamelCase name.
  • Your macro is named appropriately.
  • Your macro contains a Metadata section that immediately follows the header description.
  • Your macro is Python3/Qt5 compliant and tested on the latest FreeCAD stable and development releases.
  • You're including documentation on how your macro works (bonus: screenshots and/or video on the Wiki)
  • Commit message is well-written
  • Commit message is titled in the following way [MacroName] Short description.
  • Optional, write or update the changelog in the macro, from latest to oldest.

And please remember to update the Wiki with the features added or changed once this PR is merged.
Note: If you don't have wiki access, then please mention your contribution on the 0.19 Changelog Forum Thread.


…rator for Wiki

Usage:
- Create one object and don't change its default values.
- Select the scripted object on the tree view and  execute the macro.
- Mark the checkbox if necessary (it prints "|Dynamic" on the user
  properties, but not really on use on Wiki pages) and choose the option
  for the properties you need on your article.
- On the `Report View` you'll see printed text that you should copy on
  the Wiki page.

Forum post: https://forum.freecadweb.org/viewtopic.php?f=21&t=61998
Copy link
Collaborator

@galou galou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@galou galou merged commit 4254f35 into FreeCAD:master Nov 22, 2024
1 check failed
@hasecilu
Copy link
Contributor Author

I'll attend the change requests but it got merged before I could make them =/ . fixup! commits are supposed to be squashed to the original commit. I suppose I'll make another PR.

@hasecilu hasecilu deleted the WikiObjectPropertiesListGenerator branch November 22, 2024 18:23
@galou
Copy link
Collaborator

galou commented Nov 22, 2024

I merged because there was nothing blocking it but didn't look at the commits, sorry.

@hasecilu
Copy link
Contributor Author

hasecilu commented Nov 23, 2024

I merged because there was nothing blocking it but didn't look at the commits, sorry.

Yeah no problem, generally a good workflow would be that all change requests are done via fixup! commits and I could even comment the hash of the commit on each review to facilitate the review of the changes. After all of that fixup! commits are squashed and you get a clean commit history instead of 5 commits for the same macro.

I think this workflow could be mentioned on the https://github.com/FreeCAD/DevelopersHandbook

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants