Closed Bug 1330034 Opened 7 years ago Closed 7 years ago

Fix sync ping documentation

Categories

(Firefox :: Sync, defect, P1)

Product:
Firefox
Component:
Sync
Type:
defect
Points:
1

Tracking

()

Status:
RESOLVED FIXED
Milestone:
Firefox 53
Tracking Flags:
Tracking Status
firefox53 --- fixed

People

(Reporter: gfritzsche, Assigned: gfritzsche)

Details

(Whiteboard: [measurement:client])

Attachments

(1 file)

Fix sync ping documentation
2.29 KB, patch
markh
: review+
Details | Diff | Splinter Review 
      No description provided.
I noticed that the current level of sync ping documentation captions are off, not working properly the readthedocs layout. Also, undefined is specified where null is used AFAICT.
Attachment #8825463 - Flags: review?(markh)
Whiteboard: [measurement:client]
Comment on attachment 8825463 [details] [diff] [review]
Fix sync ping documentation

Review of attachment 8825463 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks! For my info, how do we test this in the future? I tried an online rest viewer, but knowing how to test in-tree would be helpful.
Attachment #8825463 - Flags: review?(markh) → review+
The quick local way is using `mach doc`, which generates docs in `<obj>/docs/html/Mozilla_Source_Tree_Docs/`.
Sadly this doesn't exactly match the readthedocs style (e.g. doesn't have the left-hand nested TOC), but it's good enough.
Keywords: checkin-needed
Priority: -- → P1
Pushed by ihsiao@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/56c6a09d3d34
Fix sync ping documentation. r=markh.
Keywords: checkin-needed
Points: --- → 1
https://hg.mozilla.org/mozilla-central/rev/56c6a09d3d34
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
status-firefox53: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → Firefox 53
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: