Topic: print statements and other files

My addons are ready but i wait for the ui-plugins3 branch to be merged before i upload them.

Merged a minute ago

• My scripts contain currently some print statements for informational purposes (e.g. memory consumption). I think they do not harm or are disturbing at all, but should they be removed?

IMO it is cleaner to remove all such statements, but for add-ons, best coding practices are entirely optional

• I have also added a gimp .xcf-file to allow others to modify the used add-on icons. And of course to have anything in one place. Should those xcf-files also be removed?

Depends on the size and how important sharing the sources is to you, IMO. If they're just a few kB it doesn't hurt to include them. If you have really big source assets, they shouldn't be bundled with the add-on and if you want to share them I'd recommend uploading them to a repo on CB/GH or elsewhere.

• Last but not least: I used git to manage my changes. Will the hidden folder .git be uploaded also? If so, can this be prevented?

Ouch. TBH I had not thought of add-on developers being so diligent about version control…
Yes it would be uploaded, and this should really be avoided. Please copy the final add-on files to a separate .wad folder and upload that instead. So you'd have "my_addon_devel.wad" with its own .git dir and other development stuff, and copy only the relevant files to "my_addon.wad" before uploading.

Maybe I should add something to prevent this: a hardcoded exclusion list of common VCS dirs like ".git" and ".bzr", or how about a .gitignore-style ".wlignore" that allows you to exclude arbitrary files and directories from uploading?

Top

Quote

Thanks

Hm, the print statements... it is just interesting how memory consumption grows and shrinks after a cellectgarbage. Especially the analyse_map add-on needs a lot of memory if you analyse a very, very big map as a whole. In one of the first versions it was about 10GB... now it's "only" 1,7 GB. I think i'll leave them in the analyse_map add-on and remove them in the height_tools add-on which is not that memory hungry.

The xcf-files have just 36kb, i'll keep them in the add-on.

Git is just a nice helper if you have a working solution but you want to make some refactoring or add new stuff to the UI... . Will create a new folder then. And for uploading i think just ignoring hidden files would be sufficient, imho.

Top

Quote