{"action":"created","issue":{"url":"https://api.github.com/repos/oppia/oppia/issues/4374","repository_url":"https://api.github.com/repos/oppia/oppia","labels_url":"https://api.github.com/repos/oppia/oppia/issues/4374/labels{/name}","comments_url":"https://api.github.com/repos/oppia/oppia/issues/4374/comments","events_url":"https://api.github.com/repos/oppia/oppia/issues/4374/events","html_url":"https://github.com/oppia/oppia/issues/4374","id":286365017,"number":4374,"title":"Update docstrings in the python backend code.","user":{"login":"vibhor98","id":26625980,"avatar_url":"https://avatars3.githubusercontent.com/u/26625980?v=4","gravatar_id":"","url":"https://api.github.com/users/vibhor98","html_url":"https://github.com/vibhor98","followers_url":"https://api.github.com/users/vibhor98/followers","following_url":"https://api.github.com/users/vibhor98/following{/other_user}","gists_url":"https://api.github.com/users/vibhor98/gists{/gist_id}","starred_url":"https://api.github.com/users/vibhor98/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vibhor98/subscriptions","organizations_url":"https://api.github.com/users/vibhor98/orgs","repos_url":"https://api.github.com/users/vibhor98/repos","events_url":"https://api.github.com/users/vibhor98/events{/privacy}","received_events_url":"https://api.github.com/users/vibhor98/received_events","type":"User","site_admin":false},"labels":[{"id":383795041,"url":"https://api.github.com/repos/oppia/oppia/labels/backend","name":"backend","color":"d4c5f9","default":false}],"state":"open","locked":false,"assignee":{"login":"yashLadha","id":18033231,"avatar_url":"https://avatars3.githubusercontent.com/u/18033231?v=4","gravatar_id":"","url":"https://api.github.com/users/yashLadha","html_url":"https://github.com/yashLadha","followers_url":"https://api.github.com/users/yashLadha/followers","following_url":"https://api.github.com/users/yashLadha/following{/other_user}","gists_url":"https://api.github.com/users/yashLadha/gists{/gist_id}","starred_url":"https://api.github.com/users/yashLadha/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yashLadha/subscriptions","organizations_url":"https://api.github.com/users/yashLadha/orgs","repos_url":"https://api.github.com/users/yashLadha/repos","events_url":"https://api.github.com/users/yashLadha/events{/privacy}","received_events_url":"https://api.github.com/users/yashLadha/received_events","type":"User","site_admin":false},"assignees":[{"login":"yashLadha","id":18033231,"avatar_url":"https://avatars3.githubusercontent.com/u/18033231?v=4","gravatar_id":"","url":"https://api.github.com/users/yashLadha","html_url":"https://github.com/yashLadha","followers_url":"https://api.github.com/users/yashLadha/followers","following_url":"https://api.github.com/users/yashLadha/following{/other_user}","gists_url":"https://api.github.com/users/yashLadha/gists{/gist_id}","starred_url":"https://api.github.com/users/yashLadha/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yashLadha/subscriptions","organizations_url":"https://api.github.com/users/yashLadha/orgs","repos_url":"https://api.github.com/users/yashLadha/repos","events_url":"https://api.github.com/users/yashLadha/events{/privacy}","received_events_url":"https://api.github.com/users/yashLadha/received_events","type":"User","site_admin":false},{"login":"jervis446","id":22105326,"avatar_url":"https://avatars2.githubusercontent.com/u/22105326?v=4","gravatar_id":"","url":"https://api.github.com/users/jervis446","html_url":"https://github.com/jervis446","followers_url":"https://api.github.com/users/jervis446/followers","following_url":"https://api.github.com/users/jervis446/following{/other_user}","gists_url":"https://api.github.com/users/jervis446/gists{/gist_id}","starred_url":"https://api.github.com/users/jervis446/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jervis446/subscriptions","organizations_url":"https://api.github.com/users/jervis446/orgs","repos_url":"https://api.github.com/users/jervis446/repos","events_url":"https://api.github.com/users/jervis446/events{/privacy}","received_events_url":"https://api.github.com/users/jervis446/received_events","type":"User","site_admin":false},{"login":"apb7","id":24826041,"avatar_url":"https://avatars2.githubusercontent.com/u/24826041?v=4","gravatar_id":"","url":"https://api.github.com/users/apb7","html_url":"https://github.com/apb7","followers_url":"https://api.github.com/users/apb7/followers","following_url":"https://api.github.com/users/apb7/following{/other_user}","gists_url":"https://api.github.com/users/apb7/gists{/gist_id}","starred_url":"https://api.github.com/users/apb7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apb7/subscriptions","organizations_url":"https://api.github.com/users/apb7/orgs","repos_url":"https://api.github.com/users/apb7/repos","events_url":"https://api.github.com/users/apb7/events{/privacy}","received_events_url":"https://api.github.com/users/apb7/received_events","type":"User","site_admin":false},{"login":"vibhor98","id":26625980,"avatar_url":"https://avatars3.githubusercontent.com/u/26625980?v=4","gravatar_id":"","url":"https://api.github.com/users/vibhor98","html_url":"https://github.com/vibhor98","followers_url":"https://api.github.com/users/vibhor98/followers","following_url":"https://api.github.com/users/vibhor98/following{/other_user}","gists_url":"https://api.github.com/users/vibhor98/gists{/gist_id}","starred_url":"https://api.github.com/users/vibhor98/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vibhor98/subscriptions","organizations_url":"https://api.github.com/users/vibhor98/orgs","repos_url":"https://api.github.com/users/vibhor98/repos","events_url":"https://api.github.com/users/vibhor98/events{/privacy}","received_events_url":"https://api.github.com/users/vibhor98/received_events","type":"User","site_admin":false}],"milestone":null,"comments":137,"created_at":"2018-01-05T18:17:20Z","updated_at":"2018-03-31T09:04:39Z","closed_at":null,"author_association":"MEMBER","body":"The aim of this issue is to ensure that every backend file is properly documented. The docstrings serve as guidance to developers to help them understand what a class or a method is doing, so they must be written accurately.\r\n\r\nSome useful tips:\r\n\r\n- Please follow our [style guide](https://github.com/oppia/oppia/wiki/Coding-style-guide#general) and also the [Google Python style guide](https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments) when writing the docstrings. Make sure to follow the patterns established there as closely as possible, including spacing, capitalization and punctuation.\r\n\r\n- Make sure that the docstrings for every function include Args, Returns, Raises etc. as and when applicable. If there are no args, then you can omit writing Args. Likewise for Returns, Raises etc. as well.\r\n\r\n- If a docstring is not present in the code, or the existing one is too vague for you to understand what's going on just by looking at it, then it should be rewritten to be more clear. You'll often need to read the code as well, and do a grep to find out specific method used in several files and in many other situations.\r\n\r\n- Every argument name under Args and under Returns or Raises should have a data type mentioned along with it. Make separate efforts to analyze their data types as this might be a bit tricky sometimes and there are many chances of getting mistaken. You can, for example, try to run the method/function while temporarily adding `raise(type(X))` or `logging.info(type(X))` to get the information you need.\r\n\r\n- Leave one line before each of Args, Returns and Raises. Indent any continuation lines by 4 spaces. See existing docstrings for examples.\r\n\r\n- If you feel that some files are absent from the list or some parts of the codebase are unclear or incorrectly factored, please feel free to bring this up!\r\n\r\n**Running tests on a specific file**\r\n- Go to the directory where the file is present (say-- if the file is in core directory, perform `cd core` to reach to the directory).\r\n- Execute `pylint --disable=all --enable=missing-docstring <filename>` to perform linter checks on the file.\r\n- Add docstrings for the lines where you find 'Missing docstrings'.\r\n\r\nHere is the list of files that are required to be updated.\r\n**Note:** Once this issue is complete, we will turn on missing-docstring checks in Oppia's Python linter. Also, take care that `*_test.py` files have been excluded from the list as they don't require docstrings in detail.\r\n\r\n**Needs to be done:**\r\n\r\n- [ ] core.jobs @GanitGenius \r\nAdd docstrings for classes at line no.- 518, 581, 613, 643, 846, 934\r\n- [ ] core.domain.acl_decorators\r\n- [ ] core.domain.feedback_jobs_continuous @Sunil16202 \r\nAdd docstrings for class at line no:- 30,36,185\r\n- [ ] core.domain.stats_jobs_continuous @Sunil16202\r\n- [ ] core.domain.user_jobs_continuous @GanitGenius \r\n- [ ] core.domain.user_jobs_one_off @GanitGenius \r\n- [ ] core.storage.collection.gae_models\r\n- [ ] core.storage.email.gae_models\r\n- [ ] core.storage.exploration.gae_models\r\n- [ ] core.storage.feedback.gae_models\r\n- [ ] core.storage.file.gae_models\r\n- [ ] core.tests.test_util_jobs\r\n- [ ] core.tests.test_utils\r\n\r\n**Completed:**\r\n\r\n  - [x] core.controllers.base @apb7 \r\nAdd docstrings for methods at line no.- 134, 537\r\n- [x] core.controllers.cron @WickedBrat \r\nAdd docstrings for class at line no.- 109  \r\n- [x] core.controllers.collection_editor @vibhor98\r\nAdd docstrings for classes at line no.- 165, 201\r\n- [x] core.controllers.learner_dashboard @hundredrab \r\nAdd docstrings for class at line no.- 121\r\nAdd docstrings for methods at line no.- 33, 124\r\n- [x] core.controllers.pages @Vishnu-M \r\nAdd docstrings for method at line no.- 28\r\n- [x] core.domain.classifier_domain @apb7\r\nAdd docstrings for methods at line no.- 45, 173\r\n- [x] core.domain.collection_domain @vibhor98\r\nAdd docstrings for methods at line no.-\r\nAdd docstrings for class at line no.- 32\r\n- [x] core.domain.config_domain @vibhor98\r\n- [x] core.domain.email_manager @vibhor98\r\nAdd docstrings for methods at line no.- 37, 928, 939\r\n- [x] core.domain.email_subscription_services @Kunalgarg2100 \r\nAdd docstrings for method at line no.- 21\r\n- [x] core.domain.fs_domain @vibhor98\r\n- [x] core.domain.param_domain @jervis446 \r\nAdd docstrings for method at line no.- 146\r\n- [x] core.domain.stats_domain @vibhor98\r\n- [x] core.domain.stats_jobs_one_off @abhimanyuthakre\r\n- [x] core.domain.user_query_services @proishan11 \r\n- [x] core.domain.user_services @proishan11 \r\n- [x] core.domain.value_generators_domain @vasutomar \r\n- [x] core.platform.models @joydeep1701\r\n- [x] core.platform.email.gae_email_services @square-1111 \r\n- [X] core.storage.job.gae_models @divyadeep1 "},"comment":{"url":"https://api.github.com/repos/oppia/oppia/issues/comments/377678501","html_url":"https://github.com/oppia/oppia/issues/4374#issuecomment-377678501","issue_url":"https://api.github.com/repos/oppia/oppia/issues/4374","id":377678501,"user":{"login":"vibhor98","id":26625980,"avatar_url":"https://avatars3.githubusercontent.com/u/26625980?v=4","gravatar_id":"","url":"https://api.github.com/users/vibhor98","html_url":"https://github.com/vibhor98","followers_url":"https://api.github.com/users/vibhor98/followers","following_url":"https://api.github.com/users/vibhor98/following{/other_user}","gists_url":"https://api.github.com/users/vibhor98/gists{/gist_id}","starred_url":"https://api.github.com/users/vibhor98/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vibhor98/subscriptions","organizations_url":"https://api.github.com/users/vibhor98/orgs","repos_url":"https://api.github.com/users/vibhor98/repos","events_url":"https://api.github.com/users/vibhor98/events{/privacy}","received_events_url":"https://api.github.com/users/vibhor98/received_events","type":"User","site_admin":false},"created_at":"2018-03-31T09:04:39Z","updated_at":"2018-03-31T09:04:39Z","author_association":"MEMBER","body":"Hi @GanitGenius , Are you working on the assigned files for updating the docstrings? Thanks!"}}
{"actor":{"display_login":"vibhor98"}}