Closed hhkaos closed 11 months ago
Which should be the conventions about the snippet name?
Just to keep in mind, when you are typing a lot of built-in snippets shows up:
Important note: names have to be unique.
Ideas/questions about how names should be defined:
Q1) Does it make sense to add something like Esri JS API? to differentiate (from others?).A: I don't think so, it would make it very long.
Q2) Do we allow spaces or use camelcase? (E.g. List map styles vs ListMapStyles).A: I think we should allow spaces.
List map styles
ListMapStyles
Q3) Do we recommend not to use more than... 5? words. (to describe what it does)A: I would say yes.
Q4) We just split words? (E.g. createMap to Create Map).A: I would split and start with capitals.
createMap
Create Map
Q5) Do we use the same name but with 2D & 3D suffixes when there are equivalent snippets for 2D and 3D?.A: I think we should.
Which should be the conventions about the snippet name?
Just to keep in mind, when you are typing a lot of built-in snippets shows up:
Ideas/questions about how names should be defined:
Q1) Does it make sense to add something like Esri JS API? to differentiate (from others?).
A: I don't think so, it would make it very long.
Q2) Do we allow spaces or use camelcase? (E.g.
List map styles
vsListMapStyles
).A: I think we should allow spaces.
Q3) Do we recommend not to use more than... 5? words. (to describe what it does)
A: I would say yes.
Q4) We just split words? (E.g.
createMap
toCreate Map
).A: I would split and start with capitals.
Q5) Do we use the same name but with 2D & 3D suffixes when there are equivalent snippets for 2D and 3D?.
A: I think we should.