Skip to content
This repository has been archived by the owner on Oct 4, 2020. It is now read-only.

Commit

Permalink
Document the Raw class with a code sample
Browse files Browse the repository at this point in the history
  • Loading branch information
SamWhited committed May 19, 2015
1 parent 26f49b5 commit 43c0074
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions rawkit/raw.py
Expand Up @@ -3,6 +3,20 @@

class Raw(object):

"""
Represents a raw file (of any format) and exposes development options to
the user.
For example, the basic workflow (open a file, process the file, save the
file) looks like this::
from rawkit.raw import Raw
with Raw(filename='some/raw/image.CR2') as raw:
raw.process()
raw.save(filename='some/destination/image.ppm')
"""

def __init__(self, filename=None):
"""
Create a new Raw object and load the given raw file.
Expand Down

0 comments on commit 43c0074

Please sign in to comment.