Closed Bug 1577329 Opened 5 years ago Closed 5 years ago

Convert libpref docs to Markdown

Categories

(Core :: Preferences: Backend, task, P3)

task

Tracking

()

RESOLVED FIXED
mozilla71
Tracking Status
firefox71 --- fixed

People

(Reporter: n.nethercote, Assigned: KrisWright)

Details

Attachments

(1 file)

The libpref docs are currently reStructuredText but I just learned that Markdown is also supported. Markdown is simpler and more widely known, and the libpref docs don't need anything fancy, so it would be worth converting them.

This simply requires changing the file extension from .rst to .md (hg mv modules/libpref/docs/index.{rst,md} should do it) and then modifying the syntax used within index.md. The docs can be viewed with ./mach doc modules/libpref/docs and compared against the existing ones at https://firefox-source-docs.mozilla.org/modules/libpref/libpref/index.html.

Converts modules/libpref/docs/index.rst to .md format.

Pushed by kwright@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/7d978ad4cc18
Convert index.rst to markdown r=njn
Status: NEW → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla71
Assignee: nobody → kwright
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: