wikiapi
wikiapi copied to clipboard
Clarify naming convention (project branding)
Ambiguity comes from MediaWiki API already commonly known as the wiki api
.
Recommendation 💯 🚀 👨🏼🎤
-
Wikiapi.js
(capitalized + javascript indicator) - for human-oriented documentation text, readme.md, wiki, community announcements, emails, etc. Minor arternativeWikiapiJS
. -
wikiapijs
(lowercase) - for computer-friendly url, hashtags, tags. -
wikiapi
(lowercase) - for incode usage within .js files, github repository name, npm (which is already a js ecosystem). Note: Rename npm package is bad for dependencies, cannot do there.
D3js case
Same practice as for D3.js (in human conversation), d3js (in hashtags), and d3
(in .js files and npm).
Important to note : D3 has no ambiguity with another homonyme "D3" project. We do.
Github rename
Do you mean that renaming on github changes the package's name on npm ?
After thinking. I thing we can dissociate npm&github url (using wikiapi
) from other usage in documentation and texts (using Wikiapi.js
).
Since the repositories depended on wikiapi almost use only one library to contact to MediaWiki, there is no ambiguity, the class name Wikiapi
should be properly.
I will rename the wikiapi.js to Wikiapi.js, as a class codes of Wikiapi
, and left the sample codes unchanged.
- My point is mostly for human communication : readme.md, wikipages, project's descriptions, etc. When we tell someone "I'm working with... Wikiapi.js", "You may try Wikiapi.js", etc.
- Tags, hashtags are not controversial : #wikiapijs.
- Sample codes can stay
wikiapi.some_method()
yes. Same for repositories (npm, github).
So it seems we are set for our naming convention ! Issue 40 to close when the doc, readme are up to it. 🥳
Ambiguity comes from MediaWiki API already commonly known as the
wiki api
.Recommendation 💯 🚀 👨🏼🎤
WikiapiJS
,Wikiapi.js
(capitalized + javascript indicator) - for human-oriented documentation text, readme.md, wiki, community announcements, emails, etc.wikiapijs
(lowercase) - for computer-friendly url, hashtags, tags.wikiapi
(lowercase) - for incode usage within .js files, github repository name, npm (which is already a js ecosystem). Note: Rename npm package is bad for dependencies, cannot do there.
I agree the recommendation.
I think we can call our project WikiapiJS
or Wikiapi.js
in general talking, not to confused with API of MediaWiki, it is OK.
For tags, we use wikiapijs
, it is just completed.
And using wikiapi
as instance of class Wikiapi
. It is what we doing now.
For WikiapiJS
and Wikiapi.js
, which one is better? I do not have idea...
Same. Let me few days to think the pro and con and I will make a recommendation.