Summary

Fix up code style and documentation in ClearCase implementation.

Review Request #11288 — Created Nov. 19, 2020 and submitted Nov. 27, 2020, 10:22 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change fixes up a bunch of style issues and code documentation in
the old ClearCase implementation. I've also removed an old fallback for
a no-longer-supported version of Python.

Testing Done

Ran unit tests.

Commits

Summary	ID
Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	52b8e196ffcdcf988d5d807e97ad17135d551fdf

Issues

Description	From	Last Updated
E722 do not use bare except'	reviewbot	Nov. 19, 2020, 12:42 a.m.
While here, want to add Args and Returns?	chipx86	Nov. 20, 2020, 4:56 p.m.
:py:attr for these?	chipx86	Nov. 20, 2020, 4:56 p.m.
Is "object" correct? Or should this be "file", here and below?	chipx86	Nov. 20, 2020, 4:57 p.m.
We should probably use a full path to these constants.	chipx86	Nov. 20, 2020, 4:58 p.m.
Missing the full class path.	chipx86	Nov. 20, 2020, 4:59 p.m.
Double backticks around extended_path?	chipx86	Nov. 20, 2020, 5 p.m.
We can pass a tuple of choices to startswith, to simplify this.	chipx86	Nov. 20, 2020, 5:01 p.m.
"oid" or "OID"?	chipx86	Nov. 20, 2020, 4:55 p.m.
This should be the full class path.	chipx86	Nov. 20, 2020, 5:01 p.m.
Can you make extended_path a literal?	chipx86	Nov. 20, 2020, 5:01 p.m.
E902 TokenError: EOF in multi-line statement	reviewbot	Nov. 20, 2020, 5:10 p.m.
E999 SyntaxError: invalid syntax	reviewbot	Nov. 20, 2020, 5:09 p.m.
This needs to be a tuple.	chipx86	Nov. 24, 2020, 7:44 p.m.
, optional	chipx86	Nov. 24, 2020, 7:44 p.m.
, unused	chipx86	Nov. 24, 2020, 7:44 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/scmtools/clearcase.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E722 do not use bare except'
```

Commits:

	Summary	ID
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	d20bcbc7de893dbb329e526f3388767d44234e1a
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	2cb1db7f7bb2c0b62982fe6ad6a24923baf9aa1d

Diff:

Revision 2 (+598 -204)

Show changes

reviewboard/scmtools/clearcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
While here, want to add Args and Returns?
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
:py:attr for these?
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Is "object" correct? Or should this be "file", here and below?
```
1. david Nov. 20, 2020, 5:01 p.m.
  Probably "element" is most correct.
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
We should probably use a full path to these constants.
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing the full class path.
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Double backticks around extended_path?
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
We can pass a tuple of choices to startswith, to simplify this.
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been dropped. Show all issues
```
"oid" or "OID"?
```
1. david Nov. 20, 2020, 5:01 p.m.
  IBM's docs use "oid".
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This should be the full class path.
```
reviewboard/scmtools/clearcase.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can you make extended_path a literal?
```

Commits:

	Summary	ID
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	2cb1db7f7bb2c0b62982fe6ad6a24923baf9aa1d
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	76454bac65bcf1161006965965e5a6eb30a56329

Diff:

Revision 3 (+624 -210)

Show changes

reviewboard/scmtools/clearcase.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/scmtools/clearcase.py (Diff revision 3)
The issue has been resolved. Show all issues
```
E902 TokenError: EOF in multi-line statement
```
reviewboard/scmtools/clearcase.py (Diff revision 3)
The issue has been resolved. Show all issues
```
E999 SyntaxError: invalid syntax
```

Change Summary:

Syntax.

Commits:

	Summary	ID
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	76454bac65bcf1161006965965e5a6eb30a56329
	Fix up code style and documentation in ClearCase implementation. This change fixes up a bunch of style issues and code documentation in the old ClearCase implementation. I've also removed an old fallback for a no-longer-supported version of Python. Testing Done: Ran unit tests.	52b8e196ffcdcf988d5d807e97ad17135d551fdf

Diff:

Revision 4 (+624 -210)

Show changes

reviewboard/scmtools/clearcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/scmtools/clearcase.py (Diff revision 4)
The issue has been resolved. Show all issues
```
This needs to be a tuple.
```
reviewboard/scmtools/clearcase.py (Diff revision 4)
The issue has been resolved. Show all issues
```
, optional
```
reviewboard/scmtools/clearcase.py (Diff revision 4)
The issue has been resolved. Show all issues
```
, unused
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (0e82c5e)