Summary

Add documentation throughout the Subversion code.

Review Request #13224 — Created Aug. 20, 2023 and submitted Aug. 24, 2023, 3:03 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Blocks

13225

Reviewers

Groups

reviewboard

People

Description

Some of the docs reference types that don't currently exist, but will be
available in the next change in this series.

Testing Done

Built the docs and checked for any new errors.

Commits

Summary	ID
Add documentation throughout the Subversion code. This fleshes out our codebase documentation for Subversion, documenting all modules, functions, and classes, in an effort to clean up the code and explain the purposes of some functions in preparation for upcoming code cleanups needed for the SSL functionality. Some of the docs reference types that don't currently exist, but will be available in the next change in this series.	d9f1a12d36500035ca3bfdaa8b4a3a62f331a201

Summary

Add documentation throughout the Subversion code.

This fleshes out our codebase documentation for Subversion, documenting all modules, functions, and classes, in an effort to clean up the code and explain the purposes of some functions in preparation for upcoming code cleanups needed for the SSL functionality. Some of the docs reference types that don't currently exist, but will be available in the next change in this series.

d9f1a12d36500035ca3bfdaa8b4a3a62f331a201

Issues

Description	From	Last Updated
IndentationError: unexpected indent Column: 8 Error code: E999	reviewbot	Aug. 20, 2023, 12:35 a.m.
"upwards of a fixed number" is weird. Maybe "up to a fixed number"?	david	Aug. 24, 2023, 3:02 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/scmtools/svn/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
IndentationError: unexpected indent

Column: 8
Error code: E999
```

Change Summary:

Fixed a missing line from a bad git add -p.

Commits:

	Summary	ID
	Add documentation throughout the Subversion code. This fleshes out our codebase documentation for Subversion, documenting all modules, functions, and classes, in an effort to clean up the code and explain the purposes of some functions in preparation for upcoming code cleanups needed for the SSL functionality. Some of the docs reference types that don't currently exist, but will be available in the next change in this series.	42a69939e38856a3da69498c271ebeda2f846720
	Add documentation throughout the Subversion code. This fleshes out our codebase documentation for Subversion, documenting all modules, functions, and classes, in an effort to clean up the code and explain the purposes of some functions in preparation for upcoming code cleanups needed for the SSL functionality. Some of the docs reference types that don't currently exist, but will be available in the next change in this series.	d9f1a12d36500035ca3bfdaa8b4a3a62f331a201

Diff:

Revision 2 (+1532 -152)

Show changes

	reviewboard/scmtools/core.py
	reviewboard/scmtools/svn/__init__.py
	reviewboard/scmtools/svn/base.py
	reviewboard/scmtools/svn/pysvn.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/scmtools/svn/__init__.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"upwards of a fixed number" is weird. Maybe "up to a fixed number"?
```

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (c59d302)