Skip to content

DOC: freeze old whatsnew #6856 #41442

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

Closed
wants to merge 3 commits into from

Conversation

fangchenli
Copy link
Member

xref #6856

@@ -45,8 +45,7 @@ want to broadcast, we are phasing out this special case (Zen of Python:
*Special cases aren't special enough to break the rules*). Here's what I'm
talking about:

.. ipython:: python
:okwarning:
.. code-block:: python
Copy link
Contributor

Choose a reason for hiding this comment

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

i think we need to actually paste in the ipython prompts of the execution (e.g. execute the block and paste in the docs)

@datapythonista
Copy link
Member

As Jeff says, this is unfortunately more complex than simply replacing the directives. See those:

.. ipython:: python
   print('hello world')

.. code-block:: python
   >>> print('hello world')
   hello world

The reason we use the ipython directive is that we don't need to write the >>> or the output, just the code. So, to do this, we need to add those two to every example. :\

If we want to do this, what I'd recommend is to use the master issue to keep track of all the files to edit. And then increasingly create issues for each individual file, and label them as "good first issue". Maybe you can work on the first file yourself, so there is a reference PR for the other issues. But this is a lot of work, and too much for a single person in my opinion. And we surely don't want to review PRs with more than one file updated IMHO.

@jreback
Copy link
Contributor

jreback commented May 14, 2021

closing this as being done in pieces

@jreback jreback closed this May 14, 2021
@fangchenli fangchenli deleted the freeze-old-whatsnew branch November 18, 2022 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants