update documentation

Author: Teque5

docs/source/quickstart.rst

@@ -55,16 +55,16 @@ Save a Numpy array as a SigMF Recording
     data = np.zeros(1024, dtype=np.complex64)
 
     # write those samples to file in cf32_le
-    data.tofile('example_cf32.sigmf-data')
+    data.tofile("example.sigmf-data")
 
     # create the metadata
     meta = SigMFFile(
-        data_file='example_cf32.sigmf-data', # extension is optional
+        data_file="example.sigmf-data", # extension is optional
         global_info = {
-            SigMFFile.DATATYPE_KEY: get_data_type_str(data),  # in this case, 'cf32_le'
+            SigMFFile.DATATYPE_KEY: get_data_type_str(data),  # in this case, "cf32_le"
             SigMFFile.SAMPLE_RATE_KEY: 48000,
-            SigMFFile.AUTHOR_KEY: '[email protected]',
-            SigMFFile.DESCRIPTION_KEY: 'All zero complex float32 example file.',
+            SigMFFile.AUTHOR_KEY: "[email protected]",
+            SigMFFile.DESCRIPTION_KEY: "All zero complex float32 example file.",
         }
     )
 
@@ -78,52 +78,40 @@ Save a Numpy array as a SigMF Recording
     meta.add_annotation(100, 200, metadata = {
         SigMFFile.FLO_KEY: 914995000.0,
         SigMFFile.FHI_KEY: 915005000.0,
-        SigMFFile.COMMENT_KEY: 'example annotation',
+        SigMFFile.COMMENT_KEY: "example annotation",
     })
 
-    # check for mistakes & write to disk
-    meta.tofile('example_cf32.sigmf-meta') # extension is optional
+    # validate & write to disk
+    meta.tofile("example.sigmf-meta") # extension is optional
 
 ----------------------------------
 Attribute Access for Global Fields
 ----------------------------------
 
-SigMF-Python provides convenient attribute-style access for core global metadata fields,
-allowing you to read and write metadata using simple dot notation alongside the traditional
+SigMF-Python provides convenient attribute read/write access for core global
+metadata fields, allowing you use simple dot notation alongside the traditional
 method-based approach.
 
 .. code-block:: python
 
-    import numpy as np
-    from sigmf import SigMFFile
-
-    # create a new recording
-    meta = SigMFFile()
+    import sigmf
 
-    # set global metadata using attributes
-    meta.sample_rate = 48000
-    meta.author = '[email protected]'
-    meta.datatype = 'cf32_le'
-    meta.description = 'Example recording with attribute access'
-    meta.license = 'MIT'
-    meta.recorder = 'hackrf_one'
+    # read some recording
+    meta = sigmf.SigMFFile("sigmf_logo")
 
-    # read global metadata using attributes
+    # read global metadata
     print(f"Sample rate: {meta.sample_rate}")
-    print(f"Author: {meta.author}")
     print(f"License: {meta.license}")
 
-    # method-based approach
-    meta.set_global_field(SigMFFile.HW_KEY, 'SDR Hardware v1.2')
-    hw_info = meta.get_global_field(SigMFFile.HW_KEY)
-    print(f"Hardware: {hw_info}")
+    # set global metadata
+    meta.description = "Updated description via attribute access"
+    meta.author = "[email protected]"
 
-    # attribute and method access are equivalent
-    meta.set_global_field(SigMFFile.RECORDER_KEY, 'usrp_b210')
-    print(f"Recorder via attribute: {meta.recorder}")  # prints: usrp_b210
+    # validate & write changes to disk
+    meta.tofile("sigmf_logo_updated")
 
 .. note::
 
    Only core **global** fields support attribute access. Capture and annotation
-   fields must still be accessed using the traditional ``add_capture()`` and
-   ``add_annotation()`` methods.
+   fields must still be accessed using the traditional ``get_captures()`` and
+   ``get_annotations()`` methods.