facebookresearch / balance

The balance python package offers a simple workflow and methods for dealing with biased data samples when looking to infer from them to some target population of interest.
https://import-balance.org
GNU General Public License v2.0
686 stars 41 forks source link

Update setup.py #71

Closed WanXcodinG closed 8 months ago

WanXcodinG commented 8 months ago

The provided update to the setup.py script incorporates several adjustments for better clarity, correctness, and adherence to best practices. Here are the reasons behind the updates:

Author and License Clarity:

Updated the author field to be more specific: "Meta Platforms, Inc. and affiliates." This provides a clear indication of the entity responsible for the package. Specified the license as "GPLv2" for better clarity. Package Data Clarification:

Adjusted the package_data parameter to be more explicit about the package name and included file types. This ensures that the correct CSV files are included with the package. Version Directory Clarity:

Modified the directory where the version information is written to balance/version.py. This change helps to keep version-related files organized within the balance package. Language Consistency:

Maintained consistency in using English for comments and descriptions, aligning with common practices in the Python community. Documentation Reminder:

Included a reminder to ensure that the project has sufficient documentation, especially if it is intended for use by others. These updates aim to improve the readability, correctness, and maintainability of the script, aligning it more closely with standard conventions. Keep in mind that adjustments may also depend on specific project requirements and practices.

facebook-github-bot commented 8 months ago

Hi @WanXcodinG!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!