Sample code for API: Options module

[reefagirl]

I wrote sample code to change user options which is done via the Options module which can be viewed at https://www.mediawiki.org/wiki/API:Options.

As the code wasn't in the current repository or in the wiki page, I wrote a sample code for it.

I tested it by obtaining credentials via Special:BotPasswords, for a login token.

[silkypriya]

Based on #55

[srish]

@reefagirl Thanks for your contribution to this project! But, this is not related to any microtask that I've added to the task description on Phabricator T215682 :-/

I will try to create a microtask around the Options module and then will get back to you in a day or so!

In the future, before starting work on a topic / sending a pull request, I would appreciate it if you discuss it with me on Zulip or Phabricator. That way I can verify if the particular contribution would be helpful or not for the project at the moment.

[reefagirl]

My apologies, I will make sure to discuss topics before starting them in future.

Thank you for your help, I greatly appreciate it.

[srish]

@reefagirl I don't know your Phabricator username, but I've added your Github username next to API:Options module in the task description https://phabricator.wikimedia.org/T215682. I will be reviewing your pull request soon!

[reefagirl]

Thank you, I edited the Phabricator task description with my Phabricater username :)
Kindly let me know your feedback and suggested improvements.
I will start creating the API Documentation page in my sandbox as instructed in Phabricator.

[srish]

@reefagirl Overall your sample code looks great! Only thing I would add is that you can demonstrate in the same code how to change a few more settings maybe skin, nickname, etc.

I would like to merge this code sample when your documentation is ready to go live on MediaWiki too. I will also take another look at your code sample then. Make sure that you've actually tested it on test.wikipedia.org.

Before submitting final changes, run it with Pylint (https://www.pylint.org) to eliminate any indentation errors.

[reefagirl]

Thank you. I will do the updates and commit them soon :)

[reefagirl]

@srish thank you for your feedback. I made the commits to update the code.

The documentation I created can be found at https://www.mediawiki.org/wiki/User:Areefat/Sandbox/API:Options

Kindly let me know your feedback and any improvements to be made.

Appreciate the opportunity to contribute!

[srish]

@reefagirl Thanks a lot for your work! Here is first round of feedback https://www.mediawiki.org/wiki/Topic:Uv9lt04gmcv10ggl :)

[reefagirl]

@srish Thank you for taking your time to provide feedback.
I made the changes accordingly. I was a bit confused with the parameters section, I referred to the page suggested as well as a few other pages with a parameters section and edited it. If there are any changes let me know.
Hope it is as expected.
Thank you :)

[srish]

@reefagirl Mostly looking good :) You can remove all the translation markers as they are generated by the software... read more about it here: #74 (comment). When you are done, I will review your document one more time.

[reefagirl]

@srish Thank you,
I removed all the translation markers :)
Appreciate all the help.

[srish]

Thanks a lot for your work on this! I've made some fixes to documentation here:
https://www.mediawiki.org/wiki/User:Areefat/Sandbox/API:Options

You can copy paste the changes to MediaWiki.org. When you publish your changes make sure to say in the comment: "updated as per the improving the action API documentation project". For reference check following page's history as it recently got updated: https://www.mediawiki.org/w/index.php?title=API:Move&action=history. Let me know if you've any trouble while doing so :)

[reefagirl]

Thank you @srish , very grateful to be a part of this project.
I made the changes on MediaWiki.org :)
I would love to make more contributions to this project and hope to get the opportunity to do so.