Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: obs_seq is being used as the module import and the object name in the docs. #17

Closed
hkershaw-brown opened this issue Aug 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hkershaw-brown
Copy link
Member

Bad docs, the example has the instance of the class overides the module name

>>> from pydartdiags.obs_sequence import obs_sequence as obs_seq
>>> obs_seq = obs_seq.obs_sequence('/Users/hkershaw/DART/Bugs/DuplicateObs/NCEP+ACARS.201303_6H.obs_seq2013030306')
>>> obs_seq = obs_seq.obs_sequence('/Users/hkershaw/DART/Bugs/DuplicateObs/obs_seq.0Z.20160421')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'obs_sequence' object has no attribute 'obs_sequence'
>>> type(obs_seq)
<class 'pydartdiags.obs_sequence.obs_sequence.obs_sequence'>

vs.

>>> from pydartdiags.obs_sequence import obs_sequence as obsq
>>> obs_seq = obsq.obs_sequence('/Users/hkershaw/DART/Bugs/DuplicateObs/obs_seq.0Z.20160421')
>>> obs_seq = obsq.obs_sequence('/Users/hkershaw/DART/Bugs/DuplicateObs/NCEP+ACARS.201303_6H.obs_seq2013030306')
>>> type (obs_seq)
<class 'pydartdiags.obs_sequence.obs_sequence.obs_sequence'>
>>> type (obsq)
<class 'module'>

readme.md

@hkershaw-brown hkershaw-brown added the documentation Improvements or additions to documentation label Aug 30, 2024
hkershaw-brown added a commit that referenced this issue Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant