Xqt created this task.
Xqt added projects: Pywikibot, good first task.
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper.
Restricted Application added a comment.


  Thank you for tagging this task with #good_first_task 
<https://phabricator.wikimedia.org/tag/good_first_task/> for Wikimedia 
newcomers!
  
  Newcomers often may not be aware of things that may seem obvious to seasoned 
contributors, so please take a moment to reflect on how this task might look to 
somebody who has never contributed to Wikimedia projects.
  
  A #good_first_task <https://phabricator.wikimedia.org/tag/good_first_task/> 
is a self-contained, non-controversial task with a clear approach. It should be 
well-described with pointers to help a completely new contributor, for example 
it should clearly point to the codebase URL and provide clear steps to help a 
contributor get set up for success.  We've included some guidelines at 
https://phabricator.wikimedia.org/tag/good_first_task/ !
  
  Thank you for helping us drive new contributions to our projects <3

TASK DESCRIPTION
  **Current status**
  
  Every file has a copyright comment section on top of each file but after the 
module docstring. I tlooks like this:
  
    """Time handling module.
    
    .. versionadded:: 7.5
    """
    #
    # (C) Pywikibot team, 2007-2026
    #
    # Distributed under the terms of the MIT license.
    #
  
  **Problem**
  isort linter does not always preserve the import section and adds import 
section between docstring and copyright section.
  
  **Solution**
  Move the copyright section on top of the file but behind the sheban if any. 
The result should be:
  
    #
    # (C) Pywikibot team, 2007-2026
    #
    # Distributed under the terms of the MIT license.
    #
    """Time handling module.
    
    .. versionadded:: 7.5
    """
  
  If a file contains a shebang line (usually for scripts) ithis line should be 
kept on top. For example:
  
    #!/usr/bin/env python3
    """Script to create user-config.py. Other file names are not supported."""
    #
    # (C) Pywikibot team, 2010-2026
    #
    # Distributed under the terms of the MIT license.
    #
  
  should become
  
    #!/usr/bin/env python3
    #
    # (C) Pywikibot team, 2010-2026
    #
    # Distributed under the terms of the MIT license.
    #
    """Script to create user-config.py. Other file names are not supported."""

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

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

_______________________________________________
pywikibot-bugs mailing list -- [email protected]
To unsubscribe send an email to [email protected]

Reply via email to