Include markup retrieval in examples
Ironholds opened this issue · 3 comments
The examples all assume that the data has already been retrieved, and don't give many hints as to how to get it or what form it takes. It would be good if they included an example of grabbing the markup from MediaWiki.
My initial thought on this is that markup collection is out of the scope of the module.
If you are suggesting putting forward a potential separate module for the user to use in conjunction with this one to do the actual collection I would be interested in hearing @yuvipanda's or @halfak's thoughts as to the most straightforward method of collection.
I agree that adding it into the module seems out of scope. we should
definitely include examples, possibly using the python-mwapi module, on
using it to retrieve markup and this to parse it.
On Jan 19, 2016 7:42 PM, "Kevin Schiroo" notifications@github.com wrote:
My initial thought on this is that markup collection is out of the scope
of the module.If you are suggesting putting forward a potential separate module for the
user to use in conjunction with this one to do the actual collection I
would be interested in hearing @yuvipanda https://github.com/yuvipanda's
or @halfak https://github.com/halfak's thoughts as to the most
straightforward method of collection.—
Reply to this email directly or view it on GitHub
#21 (comment)
.
Yeah, for reference I mean example.py or even the README, not incorporating markup retrieval into the module - although the inline docs providing some pointers could be nice.