Skip to content

Commit

Permalink
DOC: Correct phrasing and typos of encoders docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
phmbressan committed Nov 17, 2024
1 parent 2ffe202 commit c8e1682
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions rocketpy/_encoders.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ def object_hook(self, obj):


def get_class_signature(obj):
"""Returns the signature of a class in the form of a string.
The signature is a dictionary with the module and name of the
object's class as strings.
"""Returns the signature of a class so it can be identified on
decoding. The signature is a dictionary with the module and
name of the object's class as strings.
Parameters
Expand All @@ -116,8 +116,8 @@ def get_class_signature(obj):


def get_class_from_signature(signature):
"""Returns the class by importing its signature and
importing its module.
"""Returns the class from its signature dictionary by
importing the module and loading the class.
Parameters
----------
Expand Down

0 comments on commit c8e1682

Please sign in to comment.