manage package namespaces more carefully

utexas-bwi / rocon_scheduler_requests

Interfaces for managing rocon scheduler requests

http://wiki.ros.org/rocon_scheduler_requests

0 stars 3 forks source link

manage package namespaces more carefully #15

Closed jack-oquin closed 10 years ago

jack-oquin commented 10 years ago

[x] Define exceptions in a separate module, make them easy to access.
[ ] Do not mix requester and scheduler interfaces in the same namespace.
[ ] Limit what is defined in rocon_scheduler_requests.

jack-oquin commented 10 years ago

To address the other two issues I would remove Requester and Scheduler from the top-level namespace, but that might require modification of existing import references.

@stonier:

Would you prefer to leave them there?
Are there other namespace issues we should consider?

jack-oquin commented 10 years ago

I don't mind leaving Requester and Scheduler in the top-level namespace.

If we do leave them there, they need to be clearly documented. Sphinx currently documents them as rocon_scheduler_requests.requester.Requester, etc. I am not sure how to fix that, although it's not wrong and does work. Maybe it's enough to mention the shorter name in the doc string for the class.

jack-oquin commented 10 years ago

We need a top-level documentation page specifically for the rocon_scheduler_requests namespace, explaining what is there and an overview of how people should use it.

Re-opening this issue until that is done.