Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace ruamel.yaml with PyYAML and Cleanup Imports (Sourcery refactored) #74

Closed
wants to merge 4 commits into from

Conversation

sourcery-ai[bot]
Copy link

@sourcery-ai sourcery-ai bot commented Jul 20, 2023

Pull Request #73 refactored by Sourcery.

Since the original Pull Request was opened as a fork in a contributor's
repository, we are unable to create a Pull Request branching from it.

To incorporate these changes, you can either:

  1. Merge this Pull Request instead of the original, or

  2. Ask your contributor to locally incorporate these commits and push them to
    the original Pull Request

    Incorporate changes via command line
    git fetch https://github.com/JakubAndrysek/MkDoxy pull/73/head
    git merge --ff-only FETCH_HEAD
    git push

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Help us improve this pull request!

Altay Sansal and others added 4 commits July 20, 2023 17:48
This commit makes several improvements with the goal of enhancing code maintainability. Several import statements have been reorganized for consistency and improved readability. ruamel.yaml package usage has been replaced with yaml PyYAML parsing. This decision was made due to its wider usage, more frequent updates, and better integration. This change also necessitates updates in requirement.txt and setup.py. Unit and UAT tests have been updated to reflect these changes. Mkdoxy version has been bumped from 1.1.5 to 1.1.6 to indicate these changes.
The library 'ruamel.yaml' was removed from the development dependencies in setup.py. This was done because it's no longer necessary for the current version of the application. The application's functionality should remain unaffected.
Comment on lines 59 to 60
yaml = YAML(typ='safe')
config = yaml.load(meta)
yaml.dump(config, sys.stdout) No newline at end of file
meta = match["meta"]
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 60-60 refactored with the following changes:

@sourcery-ai sourcery-ai bot closed this Jul 20, 2023
@sourcery-ai sourcery-ai bot deleted the sourcery/pull-73 branch July 20, 2023 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants