hugolpz
commented
3 years ago @kanasimi ... I looked for a way to both learn and help a bit.
Current
The current README.md which was gradually expanded seemed messy to me. So I reorganized the README.md's examples, see #34 . There are still some glinch, but I expect them to be fixed/removed before anyone see them.
Changes
On changes ...
- removed duplications : wiki.login, async
- Create group descriptions
- Cleaner example descriptions
- Accessible in-code comments when needed
The main point was to group related functions together :
- READ
- EDIT <------ has too many codes
- MULTI-EDIT <---- together with 3 ways to create lists ; )
- MOVE
- PARSE <------ a bit unclear
- MONITOR
- FILES
- WIKIDATA
Having clarity on these may help you in your current and long term vision hopefully. 👨🏼🎤
Future #30 #35
I'am not sure this README.md gallery of codes is still needed since:
-
30: The JSdoc3 coming with examples.
-
35: I started a demo bot repository which will contain convenient basic codes, better organized and ready to fire.
Today
- [x] #34: Today, I suggest to accept PR #34 . Some improvement are there, mainly a well structured gallery.
Coming days and shifting role
The code gallery's role can be reduced to a simple appetizer, an hint. It should quickly redirect to the JSdoc3 webpage (and the future demo bot repository). The project also gain from less code to maintain 😎 ...
What to do with this gallery of code :
- most significant and illustrative code parts could be kept in a reduced README.md gallery, to attract new users. Maybe:
- Login
- Edit members of a category
- Move page
- read wikidata.
- some parts could be moved into relevant wikiapi.js
@examplesections - some/most parts which are already in wikiapi.js
@examplesor duplications could be simply deleted.
Maintenance efforts should be shifted toward a single source of truth : JSdoc3. (And demo bot 🤖 ).
Following #30 API documentation revamp (JSDoc migration) , the README.md must be rewritten. (I propose to lead this while @kanasimi works on wikiapi.js JSDoc3 comments).
Readme.md code gallery :