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

Add some documentation to modis readers similar to hrit #813

Merged
merged 4 commits into from
Jun 27, 2019

Conversation

BENR0
Copy link
Collaborator

@BENR0 BENR0 commented Jun 11, 2019

Adds documentation similar to the one already found for xrit readers.

"""

#following link is broken
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E265 block comment should start with '# '

"""

#following link is broken
#- http://www.sciencedirect.com/science?_ob=MiamiImageURL&_imagekey=B6V6V-4700BJP-\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E265 block comment should start with '# '

"""

#following link is broken
#- http://www.sciencedirect.com/science?_ob=MiamiImageURL&_imagekey=B6V6V-4700BJP-\
#3-27&_cdi=5824&_user=671124&_check=y&_orig=search&_coverDate=11%2F30%2F2002&vie\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E265 block comment should start with '# '

#following link is broken
#- http://www.sciencedirect.com/science?_ob=MiamiImageURL&_imagekey=B6V6V-4700BJP-\
#3-27&_cdi=5824&_user=671124&_check=y&_orig=search&_coverDate=11%2F30%2F2002&vie\
#w=c&wchp=dGLzVlz-zSkWz&md5=bac5bc7a4f08007722ae793954f1dd63&ie=/sdarticle.pdf
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E265 block comment should start with '# '

@mraspaud
Copy link
Member

Anyone has a clue about what the broken link was about?

@djhoese
Copy link
Member

djhoese commented Jun 11, 2019

@mraspaud what broken link?

@mraspaud
Copy link
Member

#following link is broken
#- http://www.sciencedirect.com/science?_ob=MiamiImageURL&_imagekey=B6V6V-4700BJP-\
#3-27&_cdi=5824&_user=671124&_check=y&_orig=search&_coverDate=11%2F30%2F2002&vie\
#w=c&wchp=dGLzVlz-zSkWz&md5=bac5bc7a4f08007722ae793954f1dd63&ie=/sdarticle.pdf

@@ -15,11 +15,34 @@
#
# You should have received a copy of the GNU General Public License along with
# satpy. If not, see <http://www.gnu.org/licenses/>.
"""Reader for MODIS L2 products written with HDF4 files.
""""""Modis level 2 hdf-eos format reader
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E999 SyntaxError: invalid syntax

satpy/readers/modis_l2.py Show resolved Hide resolved
satpy/readers/modis_l2.py Show resolved Hide resolved
satpy/readers/modis_l2.py Show resolved Hide resolved
satpy/readers/modis_l2.py Show resolved Hide resolved
satpy/readers/modis_l2.py Show resolved Hide resolved
satpy/readers/modis_l2.py Show resolved Hide resolved
@coveralls
Copy link

coveralls commented Jun 12, 2019

Coverage Status

Coverage increased (+0.4%) to 83.822% when pulling a047841 on BENR0:modis_reader_documentation into ea9b4e6 on pytroll:master.

@djhoese
Copy link
Member

djhoese commented Jun 17, 2019

@BENR0 Any information on that broken link?

@BENR0
Copy link
Collaborator Author

BENR0 commented Jun 17, 2019

No I don't know what it's about. I didn't put it in there. Just noticed that it was broken when I tried it out while updating the documentation. So the question is who put it in there and can he/she remember what it was about?

@djhoese
Copy link
Member

djhoese commented Jun 17, 2019

Maybe it is just best to remove it. Looks like @mraspaud was the one who added it back in 2011: 646ab4f

@BENR0
Copy link
Collaborator Author

BENR0 commented Jun 17, 2019

When it's not possible to find out what it was about I agree.

@codecov
Copy link

codecov bot commented Jun 17, 2019

Codecov Report

Merging #813 into master will increase coverage by 0.45%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #813      +/-   ##
==========================================
+ Coverage   83.38%   83.83%   +0.45%     
==========================================
  Files         165      167       +2     
  Lines       23983    24441     +458     
==========================================
+ Hits        19998    20491     +493     
+ Misses       3985     3950      -35
Impacted Files Coverage Δ
satpy/readers/modis_l2.py 98.52% <100%> (ø) ⬆️
satpy/readers/modis_l1b.py 19.19% <100%> (ø) ⬆️
satpy/tests/test_resample.py 85.52% <0%> (-13.39%) ⬇️
satpy/readers/viirs_edr_active_fires.py 90.74% <0%> (-2.74%) ⬇️
satpy/resample.py 87.22% <0%> (-1.52%) ⬇️
satpy/readers/abi_l1b.py 94.44% <0%> (-1.5%) ⬇️
satpy/tests/test_utils.py 98.79% <0%> (-1.21%) ⬇️
satpy/readers/electrol_hrit.py 91.33% <0%> (-0.67%) ⬇️
satpy/readers/__init__.py 94.27% <0%> (-0.61%) ⬇️
satpy/tests/writer_tests/test_cf.py 98.48% <0%> (-0.44%) ⬇️
... and 45 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea9b4e6...a047841. Read the comment docs.

a pattern similar to the following one:

.. parsed-literal::
M[O/Y]D02[1/H/Q]KM.A[date].[time].[collection].[processing_time].hdf
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this render properly? Or does it need an extra line between the parsed-literal and the pattern?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

http://rst.ninjs.org/ doesn't like the parsed-literal instruction...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mraspaud That may be a sphinx-only directive. Or it may need the extra line.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://livesphinx.herokuapp.com/ Seems to be ok with no extra line and with an extra line.

Copy link
Member

@mraspaud mraspaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mraspaud mraspaud merged commit 650ef72 into pytroll:master Jun 27, 2019
@BENR0 BENR0 deleted the modis_reader_documentation branch December 31, 2020 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants