Developer Guide: Fix not parsed headers

[JulienCochuyt]

Link to issue number:

None

Summary of the issue:

The following two snippets can be found in the current Developer Guide as rendered in HTML format:

• +++ An Example Manifest File +++
• `++ Plugins and Drivers ++

These have been around for quite some time.
It seems quite obvious they should be rendered as headers, respectively:

• 4.2.2. An Example Manifest File
• 4.3. Plugins and Drivers

Description of how this pull request fixes the issue:

Adding a blank line above the first snippet fixes both issues.
I have no clue why this is.
I also removed a trailing whitespace before the second one, which does not seem to change anything.

Oddly enough, I've first discovered the second snippet, which can be also fixed on its own by adding a blank line before it.
It turns out to be unnecessary once the first snippet is fixed, though, as both get automagically rendered correctly.

Testing strategy:

Rendered the modified Developer Guide and checked both snippets are now rendered as expected.

Known issues with pull request:

4.3. Optional install / Uninstall code
becomes
4.4. Optional install / Uninstall code
and so forth.

Any eventual external reference should be updated accordingly.
I'm not aware of any.

Change log entries:

This IMHO does not deserve a change log entry.
If deemed otherwise, I would propose the following:

For Developers
A few rendering issues have been fixed in the Developer Guide, impacting headers numbering from 4.3 to 4.6.

Code Review Checklist:

• Pull Request description is up to date.
• Unit tests.
• System (end to end) tests.
• Manual tests.
• User Documentation.
• Change log entry.
• Context sensitive help for GUI changes.

[seanbudd]

@Qchristensen - do you know if this change would have any impact with external documentation (see "Known issues with pull request")?

[seanbudd]

@JulienCochuyt, Thanks for looking into this. I think I found the source of the original problem, the sub-lists above the headers weren't being terminated properly.

If you apply this patch to master the indentation after the bullet list will be fixed, as is the monospace formatting for the changed bullet points. Do you mind using this patch or if I apply it on this branch?

diff --git a/devDocs/developerGuide.t2t b/devDocs/developerGuide.t2t
index a5179638b..7528d1e84 100644
--- a/devDocs/developerGuide.t2t
+++ b/devDocs/developerGuide.t2t
@@ -724,12 +724,14 @@ Otherwise, the add-on will not install.
   - e.g "2019.1.1"
   - Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0.
   - Defaults to "0.0.0"
-  - Must be less than or equal to `lastTestedNVDAVersion`
+  - Must be less than or equal to ``lastTestedNVDAVersion``
+  -
 - lastTestedNVDAVersion (string): The last version of NVDA this add-on has been tested with.
   - e.g "2019.1.0"
   - Must be a three part version string I.E. Year.Major.Minor, or a two part version string of Year.Major. In the second case, Minor defaults to 0.
   - Defaults to "0.0.0"
-  - Must be greater than or equal to `minimumNVDAVersion`
+  - Must be greater than or equal to ``minimumNVDAVersion``
+  -
 -
 
 All string values must be enclosed in quotes as shown in the example below.

[JulienCochuyt]

@seanbudd wrote:

Thanks for looking into this. I think I found the source of the original problem, the sub-lists above the headers weren't being terminated properly.

Good catch!

Patch applied as of 61a6a2d
I also removed the now useless extra blank line.