[
https://issues.apache.org/jira/browse/YETUS-430?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ajay Yadava updated YETUS-430:
------------------------------
Attachment: YETUS-430.00.patch
Since most of my other features were blocked on it, I am uploading a draft
version. Will be happy to incorporate any suggestions.
h5. Changes in -00.patch
- Moved text utility functions to utils.py
- Removed redundant fallback imports
- Renamed utility functions to snake_case as per python's convention
*NOTE*: This should also hopefully fix the following pylint issue in reportcard
{quote}
Consider iterating the dictionary directly instead of calling .keys()
(consider-iterating-dictionary)
{quote}
Ideally I would have liked to move the jira related classes to some other
module, say jira_utils.py but the current code follows an imperative style by
making lots of changes to global variables, so it's very tightly coupled and
will need a larger effort and testing.
h5. Testing done
- Tested with the following command
{code}
python release-doc-maker/releasedocmaker.py -i --project=falcon
--projecttitle="Apache Falcon" -u --version 0.9 --version 0.10 -r -O
/tmp/falcon-docs --retries=5 --sortorder=desc --sorttype=issueid
{code}
> Refactor releasedocmaker.py in separate modules
> -----------------------------------------------
>
> Key: YETUS-430
> URL: https://issues.apache.org/jira/browse/YETUS-430
> Project: Yetus
> Issue Type: Improvement
> Components: Release Doc Maker
> Reporter: Ajay Yadava
> Assignee: Ajay Yadava
> Attachments: YETUS-430.00.patch
>
>
> releasedocmaker.py has reached 993 lines in length. We have set the upper
> limit on number of lines in a file to 1000 in .pylintrc. New additions to
> the core functionality will make it trip that line, so I propose to extract
> utility functions in a separate module. I hope it will improve readability of
> the script as well.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
