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: fix the incorrect doc style in 1.2.1 #39290

Closed
jreback opened this issue Jan 20, 2021 · 7 comments · Fixed by #42386
Closed

DOC: fix the incorrect doc style in 1.2.1 #39290

jreback opened this issue Jan 20, 2021 · 7 comments · Fixed by #42386
Assignees
Milestone

Comments

@jreback
Copy link
Contributor

jreback commented Jan 20, 2021

@jorisvandenbossche pls following up and fix the docs

it's not a style issue rather this is completely inconsistent with the current docs

we NEVER use the style - always ipython docs style

Originally posted by @jreback in #39239 (comment)

@jreback jreback changed the title @jorisvandenbossche pls following up and fix the docs DOC: fix the incorrect doc style in 1.2.1 Jan 20, 2021
@jreback jreback added this to the 1.2.1 milestone Jan 20, 2021
@jreback jreback added the Docs label Jan 20, 2021
@jorisvandenbossche jorisvandenbossche modified the milestones: 1.2.1, 1.2.2 Jan 20, 2021
@jorisvandenbossche
Copy link
Member

I moved this to the 1.2.2 milestone, there is no need to have this block the release IMO (and 1.2.2 is targetted for a few weeks anyway, which will then still update the docs for this).

Now, about the actual issue:

  • About >>> vs In [] ipython style in the code-blcocks: we actually do use this style in the docs, see eg in the 1.0.0 release notes: https://pandas.pydata.org/docs/dev/whatsnew/v1.0.0.html#dataframe-rename-now-only-accepts-one-positional-argument. We can of course still discuss that we would like to make this more consistent, but so it is not that this is "never" used
  • About code-blocks vs executed ipython directive: I of course needed some code-blocks for the behaviour that will change, therefore I prefer to use plain code blocks for the full example to have consistent look within that subsection (ipython directives and code blocks (even with ipython style In[]) look slightly different)

@jreback
Copy link
Contributor Author

jreback commented Jan 20, 2021

I moved this to the 1.2.2 milestone, there is no need to have this block the release IMO (and 1.2.2 is targetted for a few weeks anyway, which will then still update the docs for this).

Now, about the actual issue:

then pls fix those - that is incorrect

  • About code-blocks vs executed ipython directive: I of course needed some code-blocks for the behaviour that will change, therefore I prefer to use plain code blocks for the full example to have consistent look within that subsection (ipython directives and code blocks (even with ipython style In[]) look slightly different)

pls don't change what we do everywhere else

we are very consistent about using ipython and not code blocks in new code - this is done deliberately

if you want to make a style change then propose it rather than unilaterally changing

@simonjayhawkins
Copy link
Member

moving to 1.2.3

@simonjayhawkins simonjayhawkins modified the milestones: 1.2.2, 1.2.3 Feb 8, 2021
@simonjayhawkins simonjayhawkins modified the milestones: 1.2.3, 1.2.4 Mar 2, 2021
@simonjayhawkins simonjayhawkins modified the milestones: 1.2.4, 1.2.5 Apr 12, 2021
@simonjayhawkins
Copy link
Member

moved to 1.2.5

@simonjayhawkins simonjayhawkins modified the milestones: 1.2.5, 1.3 May 28, 2021
@simonjayhawkins
Copy link
Member

removing the 1.2.5 milestone. does not need to block release. added 1.3 which gives a few extra weeks to fix..

@yash112-lang
Copy link

Hello @simonjayhawkins, is this issue is still open. I am new to open source, I want to contribute.

@simonjayhawkins simonjayhawkins modified the milestones: 1.3, 1.3.1 Jun 30, 2021
@debnathshoham
Copy link
Member

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants