Skip to content

Commit

Permalink
refine(mim/__init__.py): refine the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ice-tong committed Jun 25, 2022
1 parent 7eed082 commit c8703b7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions mim/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

# flake8: noqa

####### Fix the mim command crashes due to requirements version conflict. ######
###### Fix mim command crashes problem if requirements version conflict. #######
# `pkg_resources` checks for a `__requires__` attribute in the `__main__` module
# when initializing the default working set, and uses this to ensure a suitable
# version of each affected distribution is activated.
# when initializing the default working set, and resolves its dependency to
# ensure a suitable version of each affected distribution is activated.
#
# The entry point scripts create by `setuptools` use the `__requires__` feature
# for compatibility with `easy_install` but may cause mim crash when version
# conflict exists.
#
# Hence, we here remove the `__requires__` declare in mim entry point script before
# importing pkg_resources to handle this situation. This workaround works fine so
# far, but not sure if it would cause other unknown problems or not.
# To handle this situation, we set the `__requires__` declared in mim entry point
# script from 'openmim' to '' before importing pkg_resources. This workaround works
# fine so far, but not sure if it would cause other unknown problems or not.
#
# Related Links:
# - https://github.com/open-mmlab/mim/issues/143
Expand Down

0 comments on commit c8703b7

Please sign in to comment.