Rewrap icon indicating copy to clipboard operation
Rewrap copied to clipboard

Respecting markdown

Open truegoodwill opened this issue 4 years ago • 1 comments

The following comment:

  /// <summary>
  /// This is an allocation-free linked list of timer jobs. A standard linked
  /// list causes allocations because it creates "node" objects that have
  /// "value", "next", and "previous" properties. We avoid this by adding "Next"
  /// and "Previous" properties directly to the TimerJob object and utilising
  /// them for the operation of the linked list. This comes with the following
  /// caveats:
  /// * A TimerJob can only belong to one TimerJobList at at time.
  /// * Since Add/Remove operations mutate the TimerJob, it must be removed from
  ///   one list BEFORE it is added to another. Getting these operations in the
  ///   wrong order will result in bugs. This class is NOT thread-safe.
  /// </summary>

was reformatted as

  /// <summary>
  /// This is an allocation-free linked list of timer jobs. A standard linked
  /// list causes allocations because it creates "node" objects that have
  /// "value", "next", and "previous" properties. We avoid this by adding "Next"
  /// and "Previous" properties directly to the TimerJob object and utilising
  /// them for the operation of the linked list. This comes with the following
  /// caveats: * A TimerJob can only belong to one TimerJobList at at time. *
  /// Since Add/Remove operations mutate the TimerJob, it must be removed from
  /// one list BEFORE it is added to another. Getting these operations in the
  /// wrong order will result in bugs. This class is NOT thread-safe.
  /// </summary>

It seems the bullet points are not respected. I experimented with dashes and numbers. None of it worked to preserve the points.

truegoodwill avatar Feb 07 '21 06:02 truegoodwill

Dashes and numbers do get preserved in Rust (.rs files) in single-line comments //... and ///....

Thank you for Rewrap.

peter-lyons-kehl avatar Sep 19 '22 04:09 peter-lyons-kehl