Metric-HIS.RETURN

HIS RETURN metric: Number of return points

Required inputs: RFG

Count of return statements in routine.

Possible Messages

This rule has no predefined messages.

Options

• This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity

• This rule shares the following common metric options: base_view_name, excluded_node_types, hierarchy_edge_name, hierarchy_view_name, propagate, report_all_values, report_propagated_values

• The following places define options that affect this rule: Analysis-GlobalOptions

alias_name

alias_name : str = 'Metric.HIS.RETURN'

Name under which the metric will be reported. In the RFG, a metric with this value is created, too (copied from original metric).

 

display_name

display_name : str | None = 'HIS RETURN'

Description of the metric shown in the dashboard. If None, rfg_metric_name is used.

 

max_value

max_value : int | None = 1

Maximum allowed value. None if unlimited.

 

min_value

min_value : int | None = 0

Minimum allowed value. None if unlimited.

 

rfg_metric_name

rfg_metric_name : OriginalMetrics = 'Metric.Number_Of_Returns'

Name of the node attribute storing the metric value in the RFG. The name of the RFG node attribute of the original metric.

 

Option Types

These types are used by options listed above:

OriginalMetrics

An enumeration.

 

• Metric.Number_Of_Returns