autoplot / documentation

documentation
0 stars 0 forks source link

"run" vs "execute" and other words with aliases #1

Open jbfaden opened 3 years ago

jbfaden commented 3 years ago

I just realized both "run" and "execute" are used to refer to the same action with a script. This should be avoided because it makes it difficult for new people to understand documentation and more for those whose English is a second language. This ticket will keep track of these redundancies and decide which should be used.

Another is Jython keywords vs switches, both are used. Bash has switches, IDL has keywords.

parameter vs dataset.

control vs parameter.

jbfaden commented 3 years ago

go vs play vs plot vs run. "play" should be used when either action will be invoked (plotting a file or running a script), referring to the green play button.

jbfaden commented 3 years ago

"Hidden" vs "visible" vs "active" in canvas properties.

jbfaden commented 3 years ago

"panels" vs "tabs". What is the content attached to the tabbed pane called?

jbfaden commented 3 years ago

"run" vs "execute" vs "invoke" See invokeLater function.

jbfaden commented 3 years ago

"runtime error report" and "submit error report"

jbfaden commented 3 years ago

autoplot_server uses "timeRange" while it's "timerange" in other places.

jbfaden commented 3 years ago

"render type" and "plot style" are used interchangeably.