Cleanup HostingServiceClient documentation & API
Review Request #8912 — Created April 21, 2017 and submitted
The
HostingServiceClient
client class as largely undocumented: it
contained no argument or return type docs. This has been corrected.
Several of its methods also had mutable defaults, which has been
replaced withNone
so that the values do not persist to other calls.
The_build_form_data
method has been made public and static, since it
should never have to access instance variables to do the serialization
of the provided data and is a generally useful method outside the class.
- Ran unit tests.
- Built the docs and read through them.
Description | From | Last Updated |
---|---|---|
We may also want to document the standard urlopen exceptions (URLError and HTTPError), here and in the others. |
chipx86 | |
Capitalize "The". Same with the docs below. |
chipx86 | |
Let's just do: if headers: |
chipx86 | |
"HTTP Basic Authentication", here and below. |
chipx86 | |
, optional |
chipx86 | |
, optional |
chipx86 | |
These need to be the full class paths. Same with all below. |
chipx86 | |
Got some weirdness going on here. |
chipx86 | |
""" on the next line. |
chipx86 |
- Change Summary:
-
Addressed Christian's issues
- Diff:
-
Revision 2 (+287 -19)
Checks run (3 succeeded)
- Change Summary:
-
Addressed Christian's issues
- Diff:
-
Revision 3 (+329 -58)
Checks run (2 succeeded)
- Change Summary:
-
Upload correct patch.
- Diff:
-
Revision 4 (+290 -19)