Update docs to mention naming conflicts with imported python modules

Open Beginner friendly

#1,694 opened on May 14, 2024 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-3 hours
Newbie friendliness: 68/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Quiet
Tech stack: python
Domain: documentation

Research direction

Start with the Python submodules section at the documentation link in the issue and read issue 1687 for the naming-collision context. Update that guidance to avoid the lib/ name or clearly warn that it may conflict with imported modules, including the Slack backend case. Done means the docs explain the collision and prevent the misleading import-failure diagnosis.

Written by the indexing model from the issue text.

Description

type: bug

Describe the bug
A clear and concise description of what the bug is. shows using lib/ for modules. This is fine UNLESS you are using the slack backend, which has a lib.py which occurs earlier in the search path.

The resulting error looks like an import failure, ModuleNotFoundError: No module named - when actually it's a naming collision.

To Reproduce
See https://github.com/errbotio/errbot/issues/1687 for the discovery process

Expected behavior
The docs should choose a new name, OR highlight that the lib/ name could already be taken.

If desired, I'm happy to attempt an update to the docs with some verbiage around potential naming collisions.

Dominant language: Python
Stars: 3.3k
Forks: 624
PR merge metrics: No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.