Documentation Fixes #2355

ytann · 2017-12-03T11:21:55Z

Inside sunpy/docs/guide/acquiring_data, document.rst and hek.rst has been
changed. The outputs were incorrect and missing in few sections which
have been corrected and search function is used in place or query.

nitinkgp23 · 2017-12-03T14:08:34Z

@Tannmay Replace all other instances of query() -> search() too.

dpshelio

Thanks @Tannmay. Just a couple of small changes to add.

dpshelio · 2017-12-09T22:01:30Z

docs/guide/acquiring_data/database.rst

@@ -315,7 +315,7 @@ files are downloaded.
    ...     vso.attrs.Time('2012-08-05 00:00:00', '2012-08-05 00:00:01'),
    ...     vso.attrs.Instrument('AIA'))  # doctest: +REMOTE_DATA
    >>> len(database)  # doctest: +SKIP
-    37
+    70


Notice that on the second paragraph below, it makes reference to the old value (37). Please, update it with the new on.

dpshelio · 2017-12-09T22:05:39Z

docs/guide/acquiring_data/database.rst

+
+     1    2011-06-07 06:33:02 ...               17.1               17.1
+     2    2011-06-07 06:33:03 ...               33.5               33.5
+     3    2011-06-07 06:33:29 ... 17.400000000000002 17.400000000000002


these entries defeat the purpose of showing a nice table. @Cadair, I would be happy for that to be truncated to onl y one decimal if shown in nm. What do you think?

It is pretty ugly. Its why we should use perl.

# doctest: +FLOAT_CMP should make this cleaner?

dpshelio · 2017-12-09T22:07:20Z

docs/guide/acquiring_data/database.rst

-    37 2013-08-05 00:00:02    2013-08-05 00:00:03  AIA        33.5    33.5    N/A    Yes
-    4  2011-03-19 10:54:00    2011-03-19 10:54:00  AIA_3      17.1    17.1    spring No
-    5  2014-04-09 06:00:12    2014-04-09 06:00:12  AIA_3      17.1    17.1    spring No
+    id observation_time_start observation_time_end ... wavemax  tags  starred


Why is truncating the results? is that because it's been run in a smaller window??

I've run every code in Jupyter QT Console more than once,
every time the output was truncated. So may be it's because of smaller window itself.

Could you try to make it a larger window? I don't really understand why it is truncated. What's the point to choose the fields if then we don't see these?

This output is from pytest log I dump to a file.

nabobalis · 2017-12-10T13:11:42Z

You will have to rebase this with master after the last few PRs changed some of the same documentation files.

Also if you have updated the numbers or the tables, can you please remove the #Skip flag so we can check it!

pep8speaks · 2017-12-11T10:57:19Z

Hello @Tannmay! Thanks for updating the PR.

In the file sunpy/coordinates/frames.py, following are the PEP8 issues :

Line 67:101: E501 line too long (105 > 100 characters)
Line 70:101: E501 line too long (106 > 100 characters)
Line 157:101: E501 line too long (105 > 100 characters)
Line 163:101: E501 line too long (105 > 100 characters)
Line 223:101: E501 line too long (169 > 100 characters)
Line 227:101: E501 line too long (109 > 100 characters)
Line 230:101: E501 line too long (169 > 100 characters)
Line 282:101: E501 line too long (190 > 100 characters)
Line 287:101: E501 line too long (190 > 100 characters)

In the file sunpy/database/database.py, following are the PEP8 issues :

Line 158:101: E501 line too long (104 > 100 characters)
Line 161:101: E501 line too long (103 > 100 characters)
Line 611:101: E501 line too long (101 > 100 characters)

In the file sunpy/instr/goes.py, following are the PEP8 issues :

Line 44:101: E501 line too long (133 > 100 characters)
Line 122:31: E128 continuation line under-indented for visual indent
Line 123:31: E128 continuation line under-indented for visual indent
Line 124:31: E128 continuation line under-indented for visual indent
Line 127:31: E128 continuation line under-indented for visual indent
Line 128:31: E128 continuation line under-indented for visual indent
Line 977:5: E122 continuation line missing indentation or outdented

In the file sunpy/map/mapbase.py, following are the PEP8 issues :

Line 229:1: E122 continuation line missing indentation or outdented
Line 787:13: E129 visually indented line with same indent as next logical line
Line 821:101: E501 line too long (101 > 100 characters)
Line 1111:67: E128 continuation line under-indented for visual indent
Line 1262:101: E501 line too long (103 > 100 characters)
Line 1297:101: E501 line too long (119 > 100 characters)
Line 1366:101: E501 line too long (138 > 100 characters)
Line 1409:101: E501 line too long (128 > 100 characters)
Line 1410:101: E501 line too long (128 > 100 characters)
Line 1451:101: E501 line too long (121 > 100 characters)
Line 1704:5: E129 visually indented line with same indent as next logical line

In the file sunpy/map/tests/test_mapbase.py, following are the PEP8 issues :

Line 263:13: E124 closing bracket does not match visual indentation
Line 265:13: E124 closing bracket does not match visual indentation

In the file sunpy/net/tests/test_vso.py, following are the PEP8 issues :

Line 4:1: E265 block comment should start with '# '

In the file sunpy/net/vso/vso.py, following are the PEP8 issues :

Line 325:101: E501 line too long (121 > 100 characters)
Line 507:101: E501 line too long (104 > 100 characters)
Line 515:9: E731 do not assign a lambda expression, use a def
Line 677:101: E501 line too long (103 > 100 characters)

In the file sunpy/physics/differential_rotation.py, following are the PEP8 issues :

Line 53:101: E501 line too long (133 > 100 characters)
Line 118:101: E501 line too long (110 > 100 characters)
Line 127:101: E501 line too long (112 > 100 characters)
Line 142:101: E501 line too long (125 > 100 characters)
Line 144:101: E501 line too long (190 > 100 characters)
Line 278:9: E129 visually indented line with same indent as next logical line
Line 286:101: E501 line too long (104 > 100 characters)
Line 320:101: E501 line too long (102 > 100 characters)

In the file sunpy/wcs/wcs.py, following are the PEP8 issues :

Line 19:1: E302 expected 2 blank lines, found 1
Line 32:1: E302 expected 2 blank lines, found 1
Line 45:101: E501 line too long (102 > 100 characters)
Line 80:1: E302 expected 2 blank lines, found 1
Line 92:101: E501 line too long (102 > 100 characters)
Line 101:101: E501 line too long (105 > 100 characters)
Line 116:101: E501 line too long (102 > 100 characters)
Line 197:5: E303 too many blank lines (2)
Line 197:17: E712 comparison to True should be 'if cond is True:' or 'if cond:'
Line 381:17: E712 comparison to True should be 'if cond is True:' or 'if cond:'
Line 427:101: E501 line too long (110 > 100 characters)
Line 431:1: E302 expected 2 blank lines, found 1
Line 483:1: E302 expected 2 blank lines, found 1
Line 484:101: E501 line too long (109 > 100 characters)
Line 493:101: E501 line too long (117 > 100 characters)
Line 499:101: E501 line too long (117 > 100 characters)

Comment last updated on December 11, 2017 at 11:14 Hours UTC

nabobalis · 2017-12-11T14:43:40Z

Doing the tests locally, I got a whole bunch of strange changes I had to make. Really unsure why, wondering if it could be my local ENV.

Let us see if the online build passes.

dpshelio · 2017-12-12T13:33:41Z

docs/guide/acquiring_data/database.rst

+     id observation_time_start ...      wavemin            wavemax
+    --- ---------------------- ... ------------------ ------------------
+      1    2011-06-07 06:33:02 ...               17.1               17.1
+      2    2011-06-07 06:33:01 ... 13.100000000000001 13.100000000000001


Which files are producing these long decimals? That's not good, we have to get showing a meaningful number, not the whole set of decimals.

…earch function

Then I changed some of the tables for whitespace reasons. Hopefully nothing breaks

nabobalis · 2017-12-13T14:13:53Z

@Tannmay Thanks for the changes, the database doc file was a mess for a while now and I'm glad someone came along to deal with it for us!

Hopefully we can see this into our next release (0.8.3)

ytann changed the title ~~Replaced query() with search()~~ Documentation Fixes Dec 4, 2017

dpshelio requested changes Dec 9, 2017

View reviewed changes

dpshelio approved these changes Dec 9, 2017

View reviewed changes

dpshelio reviewed Dec 12, 2017

View reviewed changes

ytann and others added 4 commits December 13, 2017 14:19

Corrected some outputs and table, and replaced query functions with s…

2892050

…earch function

some more doctest skips removed

baa10af

I added alot of remote_data flags

fcd0e70

Then I changed some of the tables for whitespace reasons. Hopefully nothing breaks

Redid the tables, they passed locally

1405c64

nabobalis added Tests Affects tests in some measure [DocFix] Documentation Affects the documentation labels Dec 13, 2017

Cadair merged commit fcb1cf3 into sunpy:master Dec 15, 2017

nabobalis mentioned this pull request Dec 17, 2017

[0.8] Backports #2347

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation Fixes #2355

Documentation Fixes #2355

ytann commented Dec 3, 2017 •

edited

nitinkgp23 commented Dec 3, 2017

dpshelio left a comment

dpshelio Dec 9, 2017

dpshelio Dec 9, 2017

nabobalis Dec 11, 2017

Cadair Dec 12, 2017

dpshelio Dec 9, 2017

ytann Dec 9, 2017

dpshelio Dec 12, 2017

nabobalis Dec 12, 2017

nabobalis commented Dec 10, 2017 •

edited

pep8speaks commented Dec 11, 2017 •

edited

nabobalis commented Dec 11, 2017 •

edited

dpshelio Dec 12, 2017

nabobalis commented Dec 13, 2017

Documentation Fixes #2355

Documentation Fixes #2355

Conversation

ytann commented Dec 3, 2017 • edited

nitinkgp23 commented Dec 3, 2017

dpshelio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nabobalis commented Dec 10, 2017 • edited

pep8speaks commented Dec 11, 2017 • edited

Comment last updated on December 11, 2017 at 11:14 Hours UTC

nabobalis commented Dec 11, 2017 • edited

Choose a reason for hiding this comment

nabobalis commented Dec 13, 2017

ytann commented Dec 3, 2017 •

edited

nabobalis commented Dec 10, 2017 •

edited

pep8speaks commented Dec 11, 2017 •

edited

nabobalis commented Dec 11, 2017 •

edited