DOC: fix code-block in the reshaping docs #28838

oktaysabak · 2019-10-08T08:38:48Z

closes DOC: fix code-block in the reshaping docs #28819

- [ x] closes #28819

if I wrote only .. code-block:: it shows in github truly but its not passing tests,. so I select python language for code-block

oktaysabak · 2019-10-08T09:45:04Z

When I review file It looks fixed but checks failing 😢
https://github.com/pandas-dev/pandas/pull/28838/files?short_path=47c625e#diff-47c625e8dc3265ed493265a79b1e823c

oktaysabak · 2019-10-08T11:51:36Z

I think we should change ".. code-block::" to ".. code:: " so its about linting problem.

oktaysabak · 2019-10-08T11:56:40Z

This is a useful link

I change the "space size before ". I hope it will pass the checks

Finally I found the solution. `E999 SyntaxError: invalid syntax causes flake8 to skip AST tests. Keep mandatory E999 issues in blocks with :flake8-group: Ignore to preserve full testing for the rest of the blocks.` [link is here](https://pypi.org/project/flake8-rst/)

oktaysabak · 2019-10-08T12:52:33Z

Finally I found the solution.
E999 SyntaxError: invalid syntax causes flake8 to skip AST tests. Keep mandatory E999 issues in blocks with :flake8-group: Ignore to preserve full testing for the rest of the blocks.
link is here

oktaysabak · 2019-10-08T15:02:44Z

if I add a whitespace after .. code-block:: flake8-rst works good but your script ! grep -n '--exclude=*.'{svg,c,cpp,html,js} --exclude-dir=env -RI "\s$" * | awk -F ":" '{print "##vso[task.logissue type=error;sourcepath=" $1 ";linenumber=" $2 ";] Tailing whitespaces found: " $3}' gives error.

So I will change code-block to .. code::

If I convert it to .. code:: it won't give E999 flake8 error and tailing whitespaces error.

I test it manually from my local computer. I hope it will work and I think this is a bug.

jorisvandenbossche · 2019-10-09T16:07:21Z

doc/source/user_guide/reshaping.rst

-   row2  0.13    NaN  0.395  0.500  0.25
-   row3   NaN  0.310    NaN  0.545   NaN
-   row4   NaN  0.100  0.395  0.760  0.24
+.. code-block:: html


This should not be highlighted as html. I think you can probably use just :: instead for having a code block without any highlighting.

Hello Joris, when I use without highlighting checks failing on AzureDevops because flake8-rst giving E999 syntax error. You should break a 'space' after "::", but when I break a space the end of line, ci/code_checks.sh gives linting error. The AzureDevops fails again.

I think you should remove the .. code-block:: html line, and in the previous have should look like:: (see the double colon).

If that doesn't work, try .. code-block:: text or .. code-block:: none

Okay I will change it to .. code-block::
You will see the AzureDevops fail on flake8-rst

I guess the default for code-block is Python, and flake-rst is validating the content of the block assuming it's Python code, hence the syntax error.

In any case, can you implement one of the proposed options @oktaysabak please. Not so important to understand the details of the problem, let's simply fix it and get this merged.

Yes flake8-rst wants a ' ' blank after .. code-block:: like this. But if I leave a blank end of line; pandas code checker fails.( ci/code_checks.sh ) So I will change it to the .. code-block:: text than I will test it locally. I hope it will fix.

datapythonista · 2019-10-15T16:53:06Z

Thanks! Did you render the html? do you mind copying a screenshot to see how it looks?

oktaysabak · 2019-10-16T09:03:32Z

Thanks! Did you render the html? do you mind copying a screenshot to see how it looks?

Yes I rendered it on my local machine.

image link

( imgur was banned in Turkey. So I uploaded the screenshot to this site. )

jreback · 2019-10-16T12:16:23Z

doc/source/user_guide/reshaping.rst

-   row2  0.13    NaN  0.395  0.500  0.25
-   row3   NaN  0.310    NaN  0.545   NaN
-   row4   NaN  0.100  0.395  0.760  0.24
+.. code-block:: text


I still dont' think this will format corectly; rather than trying to fix it this way, simply create a DataFrame and show it.

I initially thought of doing so. but requested only 'change note to the code-block'. If you want I can change it to the DataFrame then call it on .. code-block:: ipython

well, does this actually render the same as a dataframe?

I created a example_dataframe variable. Result after rendering looks like this: link
If you OK, I can commit my changes

I created a example_dataframe variable. Result after rendering looks like this: link
If you OK, I can commit my changes

*i will write DataFrame values on original 'reshaping.rst' file, this values only for show render results.

@jreback the point of this block in the docs is to show a possible result, and not an actual dataframe. The full section could maybe be rewritten, but that is outside of scope for this PR.

jorisvandenbossche · 2019-10-16T16:24:50Z

@oktaysabak Thanks for the screenshot! That's looking good, and CI is passing now ;) So merging, thanks again for your contribution!

oktaysabak · 2019-10-16T17:25:10Z

This is my first merge in a big project. Thank you !

oktaysabak added 2 commits October 8, 2019 11:36

fix code-block in the reshaping docs

d9d089c

- [ x] closes #28819

code-block selected to python

0b09517

if I wrote only .. code-block:: it shows in github truly but its not passing tests,. so I select python language for code-block

Update reshaping.rst

07971bd

oktaysabak changed the title ~~fix code-block in the reshaping docs~~ DOC: fix code-block in the reshaping docs Oct 8, 2019

oktaysabak added 2 commits October 8, 2019 15:07

Update reshaping.rst

dbff59d

I change the "space size before ". I hope it will pass the checks

jreback added the Docs label Oct 8, 2019

oktaysabak added 2 commits October 8, 2019 17:51

Update reshaping.rst

4e5cd54

Update reshaping.rst

8be9263

Update reshaping.rst

a68ed06

jorisvandenbossche reviewed Oct 9, 2019

View reviewed changes

oktaysabak and others added 2 commits October 14, 2019 19:19

Update reshaping.rst

163931a

.. code-block:: changed to .. code-block:: text

d84ff96

jreback requested changes Oct 16, 2019

View reviewed changes

jorisvandenbossche approved these changes Oct 16, 2019

View reviewed changes

jorisvandenbossche merged commit 5ad908e into pandas-dev:master Oct 16, 2019

jorisvandenbossche added this to the 1.0 milestone Oct 16, 2019

proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019

DOC: fix code-block in the reshaping docs (pandas-dev#28838)

ac9ec95

proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019

DOC: fix code-block in the reshaping docs (pandas-dev#28838)

dd10022

bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020

DOC: fix code-block in the reshaping docs (pandas-dev#28838)

4bb2eee

oktaysabak deleted the patch-1 branch January 31, 2020 07:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: fix code-block in the reshaping docs #28838

DOC: fix code-block in the reshaping docs #28838

oktaysabak commented Oct 8, 2019 •

edited by datapythonista

Loading

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019 •

edited

Loading

jorisvandenbossche Oct 9, 2019

oktaysabak Oct 9, 2019

datapythonista Oct 14, 2019

oktaysabak Oct 14, 2019

datapythonista Oct 14, 2019

oktaysabak Oct 15, 2019

datapythonista commented Oct 15, 2019

oktaysabak commented Oct 16, 2019

jreback Oct 16, 2019

oktaysabak Oct 16, 2019

jreback Oct 16, 2019

oktaysabak Oct 16, 2019

oktaysabak Oct 16, 2019

jorisvandenbossche Oct 16, 2019

jorisvandenbossche commented Oct 16, 2019

oktaysabak commented Oct 16, 2019

DOC: fix code-block in the reshaping docs #28838

DOC: fix code-block in the reshaping docs #28838

Conversation

oktaysabak commented Oct 8, 2019 • edited by datapythonista Loading

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019

oktaysabak commented Oct 8, 2019 • edited Loading

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

datapythonista commented Oct 15, 2019

oktaysabak commented Oct 16, 2019

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

jorisvandenbossche commented Oct 16, 2019

oktaysabak commented Oct 16, 2019

oktaysabak commented Oct 8, 2019 •

edited by datapythonista

Loading

oktaysabak commented Oct 8, 2019 •

edited

Loading