#45755: generate_packets.py: Add missing docstrings
Open Date: 2022-09-30 20:27
Last Update: 2022-09-30 20:27
URL for this Ticket:
https://osdn.net//projects/freeciv/ticket/45755
RSS feed for this Ticket:
https://osdn.net/ticket/ticket_rss.php?group_id=12505&tid=45755
---------------------------------------------------------------------
Last Changes/Comment on this Ticket:
2022-09-30 20:27 Updated by: alienvalkyrie
* New Ticket "generate_packets.py: Add missing docstrings" created
---------------------------------------------------------------------
Ticket Status:
Reporter: alienvalkyrie
Owner: alienvalkyrie
Type: Patches
Status: Open [Owner assigned]
Priority: 5 - Medium
MileStone: 3.2.0
Component: Bootstrap
Severity: 5 - Medium
Resolution: None
---------------------------------------------------------------------
Ticket details:
Part of #43927. There are a number of things (both from the original script and introduced while restructuring it) lacking docstrings. Most things that aren't local variables should have docstrings, including
classes
module-level functions
methods and properties (except __dunder__ methods used by Python)
instance and class variables
class-level and module-level constants
--
Ticket information of Freeciv project
Freeciv Project is hosted on OSDN
Project URL: https://osdn.net/projects/freeciv/
OSDN: https://osdn.net
URL for this Ticket:
https://osdn.net/projects/freeciv/ticket/45755
RSS feed for this Ticket:
https://osdn.net/ticket/ticket_rss.php?group_id=12505&tid=45755