Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-20674

Clean up docstrings in lsst.utils

    XMLWordPrintable

    Details

      Description

      lsst.utils docstrings are generating several syntax warnings. It should be relatively easy to clean these up:

      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/utils/18.0.0-2-gf03bb23/python/lsst/utils/wrappers.py:docstring of lsst.utils.continueClass:13: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/utils/18.0.0-2-gf03bb23/python/lsst/utils/wrappers.py:docstring of lsst.utils.inClass:13: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertListEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertRaisesRegex:7: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertRaisesRegex:8: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertRaisesRegex:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertSequenceEqual:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertSequenceEqual:12: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertSetEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertTupleEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertWarnsRegex:10: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertWarnsRegex:11: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.ExecutablesTestCase.assertWarnsRegex:14: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertListEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertRaisesRegex:7: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertRaisesRegex:8: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertRaisesRegex:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertSequenceEqual:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertSequenceEqual:12: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertSetEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertTupleEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertWarnsRegex:10: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertWarnsRegex:11: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.MemoryTestCase.assertWarnsRegex:14: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/geom/18.0.0+2/python/lsst/geom/testUtils.py:docstring of lsst.utils.tests.TestCase.assertAnglesAlmostEqual:26: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/geom/18.0.0+2/python/lsst/geom/testUtils.py:docstring of lsst.utils.tests.TestCase.assertAnglesAlmostEqual:27: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertImagesAlmostEqual:13: WARNING: Definition list ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertImagesAlmostEqual:19: WARNING: Definition list ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertListEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMaskedImagesAlmostEqual:10: WARNING: Definition list ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMaskedImagesAlmostEqual:14: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMaskedImagesAlmostEqual:16: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMaskedImagesAlmostEqual:22: WARNING: Definition list ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMasksEqual:13: WARNING: Definition list ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertRaisesRegex:7: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertRaisesRegex:8: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertRaisesRegex:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertSequenceEqual:11: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertSequenceEqual:12: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertSetEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertTupleEqual:8: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertWarnsRegex:10: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertWarnsRegex:11: WARNING: Block quote ends without a blank line; unexpected unindent.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/python/miniconda3-4.5.12/envs/lsst-scipipe-1172c30/lib/python3.7/unittest/case.py:docstring of lsst.utils.tests.TestCase.assertWarnsRegex:14: WARNING: Unexpected indentation.
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertImagesAlmostEqual:18: WARNING: Undefined substitution referenced: "val1 - val0".
      		 
      /Users/jsick/lsst/pipelines_lsst_io_stack/stacks/stack/miniconda3-4.5.12-1172c30/DarwinX86/afw/18.0.0-6-g7484c24d0/python/lsst/afw/image/testUtils.py:docstring of lsst.utils.tests.TestCase.assertMaskedImagesAlmostEqual:21: WARNING: Undefined substitution referenced: "val1 - val0".

        Attachments

          Activity

          Ascending order - Click to sort in descending order
          Hide
          Permalink
          tjenness Tim Jenness added a comment -

          Some of those are coming from unittest itself and you can't fix them...

          Show
          tjenness Tim Jenness added a comment - Some of those are coming from unittest itself and you can't fix them...
          Hide
          Permalink
          tjenness Tim Jenness added a comment -

          I can confirm that I fixed all the sphinx warnings in the utils package when I reorganized it to remove the C++ code.

          Show
          tjenness Tim Jenness added a comment - I can confirm that I fixed all the sphinx warnings in the utils package when I reorganized it to remove the C++ code.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Watchers:
            Jonathan Sick, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.