Try making it a literal block:

"""MetricResult matchers for validating metrics in PipelineResults.

example usage:
::

    result = my_pipeline.run()
    all_metrics = result.metrics().all_metrics()

    matchers = [
      MetricResultMatcher(
          namespace='myNamespace',
          name='myName',
          step='myStep',
          labels={
              'pcollection': 'myCollection',
              'myCustomKey': 'myCustomValue'
          },
          attempted=42,
          committed=42
      )
    ]
    errors = metric_result_matchers.verify_all(all_metrics, matchers)
    self.assertFalse(errors, errors)

"""
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

On Fri, Mar 1, 2019 at 3:31 PM Udi Meiri <[email protected]> wrote:

> I think it's referring to the big comment at the top of the
> sdks/python/apache_beam/testing/metric_result_matchers.py.
> The line numbers are relative to the beginning of the block.
>
> On Fri, Mar 1, 2019 at 2:21 PM Alex Amato <[email protected]> wrote:
>
>> BEAM-6761 <https://issues.apache.org/jira/browse/BEAM-6761?filter=-2>
>>
>> This is blocking my PR at the moment, the output doesn't seem to match
>> the file and I am not sure how to proceed
>>
>> pydoc Output
>>
>> https://scans.gradle.com/s/im6t66hhy4bdq/console-log?task=:beam-sdks-python:docs#L3
>> <https://www.google.com/url?q=https://scans.gradle.com/s/im6t66hhy4bdq/console-log?task%3D:beam-sdks-python:docs%23L3&sa=D&source=hangouts&ust=1551564233723000&usg=AFQjCNEblSgvJ5E5k_TxqgGujKeUGfuIOw>
>>
>> Files
>> https://github.com/apache/beam/pull/7936/files
>> <https://www.google.com/url?q=https://github.com/apache/beam/pull/7936/files&sa=D&source=hangouts&ust=1551564233724000&usg=AFQjCNGXSwba2Q4Aod3FAVcYhQXOkQgYvQ>
>>
>>
>>
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:13: WARNING: Unexpected
>> indentation.
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:15: WARNING: Block quote ends
>> without a blank line; unexpected unindent.
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:18: WARNING: Definition list
>> ends without a blank line; unexpected unindent.
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:19: WARNING: Definition list
>> ends without a blank line; unexpected unindent.
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:21: WARNING: Unexpected
>> indentation.
>> /usr/local/google/home/ajamato/go/src/
>> github.com/apache/beam/sdks/python/apache_beam/testing/metric_result_matchers.py:docstring
>> of apache_beam.testing.metric_result_matchers:22: WARNING: Block quote ends
>> without a blank line; unexpected unindent.
>>
>>
>>
>> ===== copy of the file in its current state (I will probably modify the
>> PR ====
>>
>> https://pastebin.com/8bWrPZVJ
>>
>>
>>
>>

Attachment: smime.p7s
Description: S/MIME Cryptographic Signature

Reply via email to