search

UBC-MDS / hexdropper

A Python package designed for graphic designers, developers, and color enthusiasts. It simplifies the process of obtaining hex color codes from images.
MIT License
0 stars 0 forks source link

Feedback: README file #52

Closed joeywwwu closed 8 months ago

joeywwwu commented 8 months ago
  1. Add other badges needed
joeywwwu commented 8 months ago
  1. Change install instruction conda create --name hexdropper python=3.9 -y in terminal.
joeywwwu commented 8 months ago
  1. Code provided to activate environment, following poetry install
joeywwwu commented 8 months ago
  1. Code provided for testing is- $ pytest tests/ --cov=pycounts.
joeywwwu commented 8 months ago

To help us easily, and correctly, assess this, please use create the commit messages that address the feedback something like this:

fix: Feedback addressed by ...

joeywwwu commented 8 months ago
  1. The function use instructions in the README.md instruct the user to run the code read_image.read_image(), however this did not work for me. I believe it should be replaced with read_image()
joeywwwu commented 8 months ago
  1. The documentation in the README.md also refer to a variable hex_code but this is never created. I tried to run the code literally and got an error. You could rectify this by adding a line where you store the result of rgb_to_hex() as hex_code, as you did in your vignette.
monazhu commented 8 months ago

@joeywwwu, you might already be aware of this, but I just realized that we might need to update/change the installation instructions now that our package is on PyPI (rather than the current developer's installation instructions we have right now).

joeywwwu commented 8 months ago

@monazhu thanks for reminding me! I will add a section on Installation for Users in Readme!