Bug 12768 - mdoc update replaces blank remarks with To be added.
Summary: mdoc update replaces blank remarks with To be added.
Status: RESOLVED INVALID
Alias: None
Product: Tools
Classification: Mono
Component: Doctools ()
Version: unspecified
Hardware: PC Windows
: --- normal
Target Milestone: ---
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2013-06-19 12:58 UTC by Eric Maupin
Modified: 2013-06-19 14:42 UTC (History)
2 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on GitHub or Developer Community with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED INVALID

Description Eric Maupin 2013-06-19 12:58:14 UTC
If you have a <remarks></remarks> in your docs, mdoc update will replace this empty tag with <remarks>To be added.</remarks>. If you remove the node, it will re-add it in the same manner. There is no way for you to specify "I don't want/need remarks here" and satisfy mdoc update.
Comment 1 Jonathan Pryor 2013-06-19 14:30:15 UTC
Which mdoc version is this (`mdoc --version`)? I can't repro w/ 3.0.12.0.

One thing is that when `mdoc update` updates <remarks></remarks> it inserts a newline, resulting in:

    <remarks>
    </remarks>

Using <remarks/> doesn't result in any changes from `mdoc update`.
Comment 2 Eric Maupin 2013-06-19 14:31:24 UTC
mdoc 3.0.10.0

I will update and see if that fixes the issue.
Comment 3 Eric Maupin 2013-06-19 14:42:19 UTC
Looks like this was fixed between 10 and 12.