I'm in the ephemeral position where I'm new enough to the project that I'm not used to any counterintuitive quirks, so I'm trying to document or fix them as I go along, before I no longer notice them.
I think the cfHost and cfPort variables are confusingly named and I kept having to refer to the readme because of the cognitive dissonance. As far as I know, these are not really the Lucee/ColdFusion host and port but the debugger connection information. (The Lucee host, and especially the port, are something completely different than the debugger attachment host/port.) I think something likedebugHost and debugPort wouldn't have made me go back and forth to the documentation as much as I did.
Maybe since the project is still new, it might not be too painful to make a change like that (and maybe there could be an adaptor to set the legacy variable names to the new variables, for backward compatibility).
I'm in the ephemeral position where I'm new enough to the project that I'm not used to any counterintuitive quirks, so I'm trying to document or fix them as I go along, before I no longer notice them.
I think the
cfHost
andcfPort
variables are confusingly named and I kept having to refer to the readme because of the cognitive dissonance. As far as I know, these are not really the Lucee/ColdFusion host and port but the debugger connection information. (The Lucee host, and especially the port, are something completely different than the debugger attachment host/port.) I think something likedebugHost
anddebugPort
wouldn't have made me go back and forth to the documentation as much as I did.Maybe since the project is still new, it might not be too painful to make a change like that (and maybe there could be an adaptor to set the legacy variable names to the new variables, for backward compatibility).
Just a thought.