Clarify "namespace" within "generate-entities"

[cmlh]

I will submit a pull request for this issue when I get some time but I'll make a note of this issue now while I review my git changelog and expect several more issues of the coming days :)

Can I recommend that the "-n" argument of "generate entities" be clarified as the "Unique type name" in the "Edit Entity"->"Basic Information" window of Maltego rather than "namespace" (which is a better definition than what Paterva defined in hindsight) within:

• [ ] https://github.com/allfro/canari/blob/master/src/canari/commands/generate_entities.py
• [ ] https://github.com/allfro/canari/blob/master/docs/canari.rst#id11

[allfro]

Hi @cmlh

The namespace is not the unique type name. Let me clarify with an example. Take maltego.IPv4Address for instance. The unique type name is maltego.IPv4Address however the namespace is maltego. To be specific, the namespace is everything before the last dot of the unique type name and also corresponds to the _namespace_ class variable in your canari entity definitions. The -n parameter was implemented so that you can generate entities only for the entities you've authored or are targeting in your transform package. If you want to generate an entity definition for the unique type name, then you should use the -E parameter instead.