Skip to content

Commit

Permalink
Merge pull request #2868 from joleenf/issue2836_scene_doc
Browse files Browse the repository at this point in the history
Clarify Scene Documentation without Readers
  • Loading branch information
djhoese authored Aug 4, 2024
2 parents bf0d9cd + f3a2343 commit 751af03
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
4 changes: 0 additions & 4 deletions doc/source/dev_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,3 @@ After editing the source files there the documentation can be generated locally:
make html

The output of the make command should be checked for warnings and errors.
If code has been changed (new functions or classes) then the API documentation
files should be regenerated before running the above command::

sphinx-apidoc -f -T -o source/api ../satpy ../satpy/tests
9 changes: 6 additions & 3 deletions satpy/scene.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,14 @@ def __init__(self, filenames=None, reader=None, filter_parameters=None,
will be searched for a Reader that can support the provided files. This
can take a considerable amount of time so it is recommended that
``reader`` always be provided. Note without ``filenames`` the Scene is
created with no Readers available requiring Datasets to be added
manually::
created with no Readers available. When a Scene is created with no Readers,
each xarray.DataArray must be added manually::
scn = Scene()
scn['my_dataset'] = Dataset(my_data_array, **my_info)
scn['my_dataset'] = DataArray(my_data_array, attrs={})
The `attrs` dictionary contains the metadata for the data. See
:ref:`dataset_metadata` for more information.
Further, notice that it is also possible to load a combination of files
or sets of files each requiring their specific reader. For that
Expand Down

0 comments on commit 751af03

Please sign in to comment.