jayvdb created this task.
jayvdb added subscribers: Aklapper, StudiesWorld, jayvdb, pywikibot-bugs-list.
jayvdb added projects: pywikibot-core, Pywikibot-documentation.
Herald added a project: Documentation.

TASK DESCRIPTION
  T121365 shows many instances where the docstring has 'DEPRECATED' explicitly 
added to the docstring.
  
  There will be other cases where a method is decorated with `@deprecated` but 
the docstring was not updated to mention it is deprecated, or there is no 
docstring at all.
  
  All the existing literal `DEPRECATED` in docstrings should be removed, and 
the `deprecated` decorator should add/alter the function's docstring to 
describe the deprecation for documentation.
  
  This task doesnt need to solve T121365; it could simply replicate the 
existing problem by prefixing the docstrings with 'DEPRECATED:' .
  There are alternatives which would pass the new pep257 rule, such as 
appending `(DEPRECATED).` to the end of the first line of the docstring.

TASK DETAIL
  https://phabricator.wikimedia.org/T121366

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: jayvdb
Cc: pywikibot-bugs-list, jayvdb, StudiesWorld, Aklapper, Spage



_______________________________________________
pywikibot-bugs mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikibot-bugs

Reply via email to