1. Team SimPy
  2. simpy
  3. simpy
  4. Pull requests

Pull requests

#17 Merged
Repository
simpy-boundclass
Branch
default
Repository
simpy
Branch
default

Reintroduce BoundClass and thereby reduce documentation fragmentation.

Author
  1. luensdorf
Reviewers
Description
No description

Comments (7)

  1. luensdorf author

    Also, Sphinx has some troubles with autodocing some attributes and wrongly adds = None in the documentation. I propose to fix this problem upstream instead of working around by separating our documentation and code.

  2. Stefan Scherfke

    I don’t see any benefits. Also, waiting until the = None problem is fixed in Sphinx will take too long and since the extra work has already been done to fix this on our side, I don’t see the need to change everything again.

  3. luensdorf author

    Again, the benefit of this change is the reduction documentation fragmentation. Code documentation (docstrings etc., not tutorials or examples) must be in one place and not spread between .py and .rst files. This is more important than any stylistic consideration in my opinion. Our extra work was a work-around and work-arounds are error prone and should be removed if there's a better solution (like in this pull request).

  4. luensdorf author

    Hi Stefan,

    I've updated the pull request, fixed the documentation again and also removed the schedulers as we've briefly discussed on jabber.