Skip to content

Generate markdown documentation also for none type#345

Merged
christophfroehlich merged 1 commit intomainfrom
fix-markdown-none-type
Apr 16, 2026
Merged

Generate markdown documentation also for none type#345
christophfroehlich merged 1 commit intomainfrom
fix-markdown-none-type

Conversation

@christophfroehlich
Copy link
Copy Markdown
Collaborator

Closes #266

$ generate_parameter_library_markdown --input_yaml src/ros2_controllers/chained_filter_controller/src/chained_filter_parameters.yaml --output_markdown test.md

Before:

Chained Filter Parameters

Default Config

chained_filter:
  ros__parameters:
    input_interfaces: '{}'
    output_interfaces: '{}'

input_interfaces

Name of the input state interface

  • Type: string_array
  • Default Value: {}
  • Read only: True

Constraints:

  • parameter is not empty

Additional Constraints:

output_interfaces

Name of the output state interface

  • Type: string_array
  • Default Value: {}
  • Read only: True

Constraints:

  • parameter is not empty

Additional Constraints:

After:

Chained Filter Parameters

Default Config

chained_filter:
  ros__parameters:
    <input_interfaces>:
      filter_chain: ''
    filter_chain: ''
    input_interfaces: '{}'
    output_interfaces: '{}'

input_interfaces

Name of the input state interface

  • Type: string_array

  • Default Value: {}

  • Read only: True

Constraints:

  • parameter is not empty

Additional Constraints:

output_interfaces

Name of the output state interface

  • Type: string_array

  • Default Value: {}

  • Read only: True

Constraints:

  • parameter is not empty

Additional Constraints:

filter_chain

Map of parameters that defines a filter chain, containing filterN as key. Valid for all interfaces, overrides <input_interfaces>.filter_chain if set. The fields for each filter are: type: The filter plugin to be loaded name: Actual name semantically describing the filter, e.g., low_pass_filter params: And underlying map of parameters needed for a specific filter, refer to the specific filter documentation.

<input_interfaces>.filter_chain

Instead of a single configuration, a distinct configuration can be provided for each input interface. The key is the name of the input interface, and the value is a map of parameters that defines a filter chain, containing filterN as key. The fields for each filter are: type: The filter plugin to be loaded name: Actual name semantically describing the filter, e.g., low_pass_filter params: And underlying map of parameters needed for a specific filter, refer to the specific filter

@christophfroehlich christophfroehlich added the backport-humble Triggers PR backport to ROS 2 humble. label Apr 12, 2026
Copy link
Copy Markdown
Collaborator

@bmagyar bmagyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@christophfroehlich christophfroehlich merged commit 04df0d0 into main Apr 16, 2026
8 checks passed
@christophfroehlich christophfroehlich deleted the fix-markdown-none-type branch April 16, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-humble Triggers PR backport to ROS 2 humble.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation not being generated for parameters with type = none

2 participants