Clean up, modernize, and document the the Perforce codebase.

Review Request #8944 - Created May 17, 2017 and updated

Christian Hammond
Review Board
release-2.5.x
d9ebffb...
reviewboard
The Perforce support has been around for a very long time, and there
were some warts and unused code that never got cleaned up.

This change removes some methods and parameters that weren't needed
anymore, rearranges some functions, removes unnecessary code, converts a
static method into a normal method, and adds documentation throughout
the file. It sets the stage for future work in this file.

Unit tests and real-world functionality work.

Built the docs (temporarily adding this file to the docs build -- it's
not by default) and made sure the docs were correct.

  • 2
  • 0
  • 0
  • 2
Description From Last Updated
This isn't really correct. While there is a yield in here, that's used by @contextmanager. The contextmanager wrapper will return ... David Trowbridge David Trowbridge
Should be returns here too. David Trowbridge David Trowbridge
Checks run (2 succeeded)
JSHint passed.
flake8 passed.
David Trowbridge
  1. 
      
  2. reviewboard/scmtools/perforce.py (Diff revision 1)
     
     
     

    This isn't really correct. While there is a yield in here, that's used by @contextmanager. The contextmanager wrapper will return a context manager, which isn't really a type in and of itself, but I think could be documented as object.

  3. reviewboard/scmtools/perforce.py (Diff revision 1)
     
     
     

    Should be returns here too.

Loading...