search

rapidsai / dependency-file-generator

https://pypi.org/project/rapids-dependency-file-generator/
Apache License 2.0
15 stars 13 forks source link

refactor: Add docstrings and more comments and make minor edits to improve code readability #27

Closed vyasr closed 2 years ago

vyasr commented 2 years ago

This PR adds documentation of all functions to explain their purposes and what arguments are being passed around. It also adds more inline comments to explain various different scenarios that might arise, particularly around empty keys or various non-matching cases. Finally, it includes some minor changes to the code that improve readability and remove unnecessary operations.

BREAKING CHANGE: This PR changes the names of a few functions and removes one unused one. This tag is also being used to demarcate our intention to make our first major release when this PR is merged.

vyasr commented 2 years ago

Yeah no harm in keeping as a regression test IMO.

github-actions[bot] commented 2 years ago

:tada: This PR is included in version 1.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: