Method parameter name inconsistency (enable/disable vs enabled/disabled)

[dalexeev]

I noticed that in some cases the method parameter is called enable/disable, and in others enabled/disabled.

For example:

enable/disable

95 matches

doc/classes/AnimationNode.xml: 1
147:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/AnimationNodeTransition.xml: 1
 30:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/AudioServer.xml: 4
218:  4: 			<param index="1" name="enable" type="bool" />
242:  4: 			<param index="1" name="enable" type="bool" />
266:  4: 			<param index="1" name="enable" type="bool" />
281:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/BaseMaterial3D.xml: 2
 37:  4: 			<param index="1" name="enable" type="bool" />
 45:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/CPUParticles2D.xml: 1
 78:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/CPUParticles3D.xml: 1
 79:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/CanvasItem.xml: 2
518:  4: 			<param index="0" name="enable" type="bool" />
525:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/CollisionObject2D.xml: 1
204:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/DisplayServer.xml: 1
853:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/EditorFeatureProfile.xml: 4
 66:  4: 			<param index="1" name="disable" type="bool" />
 74:  4: 			<param index="1" name="disable" type="bool" />
 83:  4: 			<param index="2" name="disable" type="bool" />
 91:  4: 			<param index="1" name="disable" type="bool" />
doc/classes/EngineDebugger.xml: 1
 50:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/EngineProfiler.xml: 1
 32:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/GraphNode.xml: 3
200:  4: 			<param index="1" name="enable" type="bool" />
208:  4: 			<param index="1" name="enable" type="bool" />
216:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/ItemList.xml: 1
325:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/Node.xml: 8
670:  4: 			<param index="0" name="enable" type="bool" />
677:  4: 			<param index="0" name="enable" type="bool" />
685:  4: 			<param index="0" name="enable" type="bool" />
692:  4: 			<param index="0" name="enable" type="bool" />
699:  4: 			<param index="0" name="enable" type="bool" />
707:  4: 			<param index="0" name="enable" type="bool" />
714:  4: 			<param index="0" name="enable" type="bool" />
721:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/Node3D.xml: 3
183:  4: 			<param index="0" name="disable" type="bool" />
203:  4: 			<param index="0" name="enable" type="bool" />
210:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/Object.xml: 2
519:  4: 			<param index="0" name="enable" type="bool" />
557:  4: 			<param index="0" name="enable" type="bool" />
doc/classes/ParticleProcessMaterial.xml: 1
 69:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/PhysicsServer2D.xml: 2
585:  4: 			<param index="1" name="enable" type="bool" />
612:  4: 			<param index="2" name="enable" type="bool" />
doc/classes/PhysicsServer2DExtension.xml: 3
535:  4: 			<param index="1" name="enable" type="bool" />
566:  4: 			<param index="2" name="enable" type="bool" />
707:  4: 			<param index="1" name="disable" type="bool" />
doc/classes/PhysicsServer3D.xml: 5
158:  4: 			<param index="1" name="enable" type="bool" />
544:  4: 			<param index="1" name="enable" type="bool" />
581:  4: 			<param index="1" name="enable" type="bool" />
598:  4: 			<param index="1" name="enable" type="bool" />
732:  4: 			<param index="3" name="enable" type="bool" />
doc/classes/PhysicsServer3DExtension.xml: 6
135:  4: 			<param index="1" name="enable" type="bool" />
488:  4: 			<param index="1" name="enable" type="bool" />
517:  4: 			<param index="1" name="enable" type="bool" />
532:  4: 			<param index="1" name="enable" type="bool" />
688:  4: 			<param index="3" name="enable" type="bool" />
1136:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/PopupMenu.xml: 3
354:  4: 			<param index="1" name="enable" type="bool" />
363:  4: 			<param index="1" name="enable" type="bool" />
371:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/RenderingServer.xml: 33
 39:  4: 			<param index="1" name="enable" type="bool" />
164:  4: 			<param index="1" name="enable" type="bool" />
504:  4: 			<param index="1" name="enable" type="bool" />
567:  4: 			<param index="1" name="enable" type="bool" />
767:  4: 			<param index="0" name="disable" type="bool" />
950:  4: 			<param index="0" name="enable" type="bool" />
956:  4: 			<param index="0" name="enable" type="bool" />
963:  4: 			<param index="1" name="enable" type="bool" />
1020:  4: 			<param index="1" name="enable" type="bool" />
1035:  4: 			<param index="1" name="enable" type="bool" />
1053:  4: 			<param index="1" name="enable" type="bool" />
1111:  4: 			<param index="1" name="enable" type="bool" />
1151:  4: 			<param index="1" name="enable" type="bool" />
1179:  4: 			<param index="1" name="enable" type="bool" />
1653:  4: 			<param index="1" name="enable" type="bool" />
1732:  4: 			<param index="1" name="enable" type="bool" />
2464:  4: 			<param index="1" name="enable" type="bool" />
2472:  4: 			<param index="1" name="enable" type="bool" />
2549:  4: 			<param index="1" name="enable" type="bool" />
2564:  4: 			<param index="1" name="enable" type="bool" />
2607:  4: 			<param index="1" name="enable" type="bool" />
2623:  4: 			<param index="1" name="enable" type="bool" />
2631:  4: 			<param index="1" name="enable" type="bool" />
2730:  4: 			<param index="0" name="enable" type="bool" />
3041:  4: 			<param index="1" name="enable" type="bool" />
3198:  4: 			<param index="1" name="disable" type="bool" />
3206:  4: 			<param index="1" name="disable" type="bool" />
3237:  4: 			<param index="1" name="enable" type="bool" />
3396:  4: 			<param index="1" name="enable" type="bool" />
3403:  4: 			<param index="1" name="enable" type="bool" />
3410:  4: 			<param index="1" name="enable" type="bool" />
3545:  4: 			<param index="1" name="enable" type="bool" />
3572:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/SkeletonModification3DCCDIK.xml: 1
116:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/Tree.xml: 1
245:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/TreeItem.xml: 2
455:  4: 			<param index="1" name="enable" type="bool" />
522:  4: 			<param index="1" name="enable" type="bool" />
doc/classes/Window.xml: 1
304:  4: 			<param index="0" name="enable" type="bool" />

enabled/disabled

82 matches

doc/classes/AStar2D.xml: 1
280:  4: 			<param index="1" name="disabled" type="bool" default="true" />
doc/classes/AStar3D.xml: 1
307:  4: 			<param index="1" name="disabled" type="bool" default="true" />
doc/classes/Animation.xml: 1
445:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/AudioServer.xml: 1
227:  4: 			<param index="2" name="enabled" type="bool" />
doc/classes/CollisionObject2D.xml: 1
196:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/CollisionObject3D.xml: 1
169:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/DisplayServer.xml: 2
556:  4: 			<param index="2" name="disabled" type="bool" />
1191:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/EditorInterface.xml: 1
246:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/HingeJoint3D.xml: 1
 29:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/ItemList.xml: 1
236:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/Label3D.xml: 1
 28:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/MenuBar.xml: 2
 61:  4: 			<param index="0" name="disabled" type="bool" />
 69:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/MenuButton.xml: 1
 23:  4: 			<param index="0" name="disabled" type="bool" />
doc/classes/Node3D.xml: 1
196:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/OS.xml: 1
563:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/OptionButton.xml: 1
147:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/PacketPeerUDP.xml: 1
 90:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/PhysicsDirectBodyState2DExtension.xml: 1
238:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/PhysicsDirectBodyState3DExtension.xml: 1
249:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/PhysicsServer2D.xml: 4
 17:  4: 			<param index="3" name="disabled" type="bool" default="false" />
181:  4: 			<param index="2" name="disabled" type="bool" />
251:  4: 			<param index="3" name="disabled" type="bool" default="false" />
622:  4: 			<param index="2" name="disabled" type="bool" />
doc/classes/PhysicsServer2DExtension.xml: 4
 15:  4: 			<param index="3" name="disabled" type="bool" />
164:  4: 			<param index="2" name="disabled" type="bool" />
224:  4: 			<param index="3" name="disabled" type="bool" />
575:  4: 			<param index="2" name="disabled" type="bool" />
doc/classes/PhysicsServer3D.xml: 5
 17:  4: 			<param index="3" name="disabled" type="bool" default="false" />
176:  4: 			<param index="2" name="disabled" type="bool" />
245:  4: 			<param index="3" name="disabled" type="bool" default="false" />
616:  4: 			<param index="2" name="disabled" type="bool" />
779:  4: 			<param index="2" name="enabled" type="bool" />
doc/classes/PhysicsServer3DExtension.xml: 5
 15:  4: 			<param index="3" name="disabled" type="bool" />
151:  4: 			<param index="2" name="disabled" type="bool" />
211:  4: 			<param index="3" name="disabled" type="bool" />
548:  4: 			<param index="2" name="disabled" type="bool" />
730:  4: 			<param index="2" name="enabled" type="bool" />
doc/classes/PopupMenu.xml: 2
387:  4: 			<param index="1" name="disabled" type="bool" />
453:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/RenderingServer.xml: 20
393:  4: 			<param index="1" name="enabled" type="bool" />
424:  4: 			<param index="1" name="enabled" type="bool" />
431:  4: 			<param index="1" name="enabled" type="bool" />
482:  4: 			<param index="1" name="enabled" type="bool" />
496:  4: 			<param index="1" name="enabled" type="bool" />
521:  4: 			<param index="1" name="enabled" type="bool" />
574:  4: 			<param index="1" name="enabled" type="bool" />
614:  4: 			<param index="1" name="enabled" type="bool" />
679:  4: 			<param index="1" name="enabled" type="bool" />
856:  4: 			<param index="1" name="enabled" type="bool" />
1465:  4: 			<param index="2" name="enabled" type="bool" />
1569:  4: 			<param index="1" name="enabled" type="bool" />
1714:  4: 			<param index="1" name="enabled" type="bool" />
1757:  4: 			<param index="1" name="enabled" type="bool" />
1765:  4: 			<param index="1" name="enabled" type="bool" />
3213:  4: 			<param index="1" name="disabled" type="bool" />
3299:  4: 			<param index="1" name="enabled" type="bool" />
3357:  4: 			<param index="1" name="enabled" type="bool" />
3364:  4: 			<param index="1" name="enabled" type="bool" />
3380:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/Skeleton3D.xml: 1
282:  4: 			<param index="1" name="enabled" type="bool" default="true" />
doc/classes/SkeletonModificationStack2D.xml: 1
 30:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/SkeletonModificationStack3D.xml: 1
 29:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/SpriteBase3D.xml: 1
 34:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/StreamPeerTCP.xml: 1
 68:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/TabBar.xml: 1
134:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/TabContainer.xml: 1
114:  4: 			<param index="1" name="disabled" type="bool" />
doc/classes/TextEdit.xml: 1
851:  4: 			<param index="0" name="enabled" type="bool" />
doc/classes/TextServer.xml: 2
1435:  4: 			<param index="1" name="enabled" type="bool" />
1443:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/TextServerExtension.xml: 2
1430:  4: 			<param index="1" name="enabled" type="bool" />
1438:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/TileMap.xml: 1
292:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/TreeItem.xml: 3
 18:  4: 			<param index="3" name="disabled" type="bool" default="false" />
431:  4: 			<param index="2" name="disabled" type="bool" />
514:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/Window.xml: 1
276:  4: 			<param index="1" name="enabled" type="bool" />
doc/classes/XRInterfaceExtension.xml: 1
162:  4: 			<param index="0" name="enabled" type="bool" />
modules/multiplayer/doc_classes/SceneReplicationConfig.xml: 2
 56:  4: 			<param index="1" name="enabled" type="bool" />
 64:  4: 			<param index="1" name="enabled" type="bool" />
modules/websocket/doc_classes/WebSocketPeer.xml: 1
 57:  4: 			<param index="0" name="enabled" type="bool" />

[Mickeon]

In my personal opinion, enable is better in these cases. It's not querying the property's value (is it enabled?). It's changing the property, the value is not yet set, but it is about to. It's like asking "setting follow_viewport_enabled. Do you enable it"?

[Lielay9]

Conversely, in the 2 examples provided, I'd favor the adjective. It makes more sense grammatically as we are setting the state of the property to true/false i.e. enabled/disabled. Personally, I associate verbs with functions or something that changes how the function works. example1

That said we should come up with a clear convention and stick to it e.g. if we here choose to use enable we should also change pressed (example) to press. Currently, there seems to be no logic in many of the classes (Node is a mess; include_internal, but not include_owned? fold, enable and then for some reason is_editable?).

[Mickeon]

Fortunately there's no rush 'cause this is mostly a documentation thing and is thus not compatibility breaking, but it would be worth to organise this sooner than later because it's a lot of manual changing around.