feat: shifted to more concise docstring style

Author: TimD1

pysam/libcbcf.pyx

@@ -3436,36 +3436,34 @@ cdef class VariantRecordSample(object):
     """Data for a single sample from a :class:`VariantRecord` object. Provides data accessors for
        genotypes and a mapping interface from FORMAT fields to values.
 
-       Notes
-       -----
-       The :class:`VariantRecordSample` object implements a mapping-like object for a specific
-       VCF/BCF row and sample column. The keys are FORMAT fields and the values are the values in
-       the VCF/BCF file. There is special handling for "GT", through the :attr:`alleles`,
-       :attr:`allele_indices` and :attr:`phased` attributes. There is also a :attr:`name` property
-       that provides the sample's name.
-
-       Examples
-       --------
-       Here is an example of accessing and printing the data in a :class:`VariantRecordSample`::
-
-           variant_file = pysam.VariantFile('/path/to/file.vcf.gz')
-           for variant_record in variant_file.fetch():
-               for sample_name in variant_record.samples:
-                   variant_record_sample = variant_record.samples[sample_name]
-                       variant_record_sample["GT"] = (0, 1)
-                       print(dict(variant_record_sample))
-
-       The above code will print the following::
-
-           {
-               'AD': (0, 80),
-               'DP': 79,
-               'GQ': 32,
-               'GT': (0, 1),
-               'PL': (33, 34, 0),
-               'VAF': (1.0,)},
-               'PS': None
-           }
+       Notes:
+         The :class:`VariantRecordSample` object implements a mapping-like object for a specific
+         VCF/BCF row and sample column. The keys are FORMAT fields and the values are the values in
+         the VCF/BCF file. There is special handling for "GT", through the :attr:`alleles`,
+         :attr:`allele_indices` and :attr:`phased` attributes. There is also a :attr:`name` property
+         that provides the sample's name.
+
+       Examples:
+         Here is an example of accessing and printing the data in a :class:`VariantRecordSample`::
+
+             variant_file = pysam.VariantFile('/path/to/file.vcf.gz')
+             for variant_record in variant_file.fetch():
+                 for sample_name in variant_record.samples:
+                     variant_record_sample = variant_record.samples[sample_name]
+                         variant_record_sample["GT"] = (0, 1)
+                         print(dict(variant_record_sample))
+
+         The above code will print the following::
+
+             {
+                 'AD': (0, 80),
+                 'DP': 79,
+                 'GQ': 32,
+                 'GT': (0, 1),
+                 'PL': (33, 34, 0),
+                 'VAF': (1.0,)},
+                 'PS': None
+             }
     """
     def __init__(self, *args, **kwargs):
         raise TypeError('this class cannot be instantiated from Python')
@@ -3594,14 +3592,12 @@ cdef class VariantRecordSample(object):
     def get(self, key, default=None):
         """Retrieve sample data for FORMAT field `key`. If `key` is not present, return `default`.
 
-        Parameters
-        ----------
-
-        key : str
-          FORMAT field to retrieve for the sample.
-        default
-          Data to return if the `key` is not present in the FORMAT field for the sample.
-          Defaults to `None`.
+        Parameters:
+          key : str
+            FORMAT field to retrieve for the sample.
+          default
+            Data to return if the `key` is not present in the FORMAT field for the sample.
+            Defaults to `None`.
         """
         try:
             return self[key]
@@ -3644,11 +3640,9 @@ cdef class VariantRecordSample(object):
     def update(self, items=None, **kwargs):
         """Update the FORMAT field values for this sample.
 
-        Parameters
-        ----------
-
-        items : dict | None
-          A dictionary or dictionary-like object used to update the FORMAT field names and values.
+        Parameters:
+          items : dict | None
+            A dictionary or dictionary-like object used to update the FORMAT field names and values.
         """
         for k, v in items.items():
             self[k] = v
@@ -3660,23 +3654,19 @@ cdef class VariantRecordSample(object):
     def pop(self, key, default=_nothing):
         """Remove the FORMAT field `key` for this sample and returns its value.
 
-        Parameters
-        ----------
-
-        key : str
-          FORMAT field to retrieve for the sample.
-        default: Any
-          Data to return if the `key` is not present.
+        Parameters:
+          key : str
+            FORMAT field to retrieve for the sample.
+          default
+            Data to return if the `key` is not present.
 
-        Raises
-        ------
-        KeyError
-          When the `key` is not present and `default` is unset.
+        Raises:
+          KeyError
+            When the `key` is not present and `default` is unset.
 
-        Returns
-        -------
-        value
-          The value of the removed FORMAT field for this sample.
+        Returns:
+          value
+            The value of the removed FORMAT field for this sample.
         """
 
         try: