Share

Port naming conventions

The following naming conventions are meant to be used as useful guidelines. They are not enforced by Bifrost unless otherwise specified.

  • Port names must start with a letter. Your node will generate an error if the port name begins with anything other than a letter.
  • Use snake_case when naming ports.
  • Try to limit your port and parameter names to four short words.
  • Give your ports descriptive names that tell the user what the input and output types are, and how the output is transformed. For example, if your node takes a vector and rotates it, name your input port vector and name your output port rotated_vector.
  • If you cannot avoid having the same name for your input and output ports, use <name> for your input ports, and out_<name> for your output port. For example, mesh and out_mesh.

Was this information helpful?