search

ros-infrastructure / catkin_pkg

Standalone Python library for the catkin build system.
https://github.com/ros/catkin
Other
46 stars 89 forks source link

Use only first line of description in distutils setup generation #326

Closed cottsay closed 2 years ago

cottsay commented 2 years ago

This is an alternative to #316 that uses only the first line of the package description in the Python distutils setup rather than converting line breaks to spaces.

I'd like to hear feedback on which approach is preferable.

cottsay commented 2 years ago

Depends on #329

cottsay commented 2 years ago

Okay, this is looking pretty good. For example: Before:

Summary: The actionlib stack provides a standardized interface for     interfacing with preemptable tasks. Examples of this include moving     the base to a target location, performing a laser scan and retu...

After:

Summary: The actionlib stack provides a standardized interface for interfacing with preemptable tasks. Examples of this include moving the base to a target location, performing a laser scan and returning th...

Dropping a <br/> after the first sentence makes this even better:

Summary: The actionlib stack provides a standardized interface for interfacing with preemptable tasks.