In the Pdb documentation, found at
https://docs.python.org/3.7/library/pdb.html?highlight=pdb#module-pdb
there is no mention of breakpoint().

In my opinion, this text

import pdb; pdb.set_trace()

should be replaced with

import pdb; pdb.set_trace()
New in version 3.7: breakpoint() replaces the previous line.

Thanks,

JM

> New in version 3.7: breakpoint() replaces the previous line.

replaces sounds little more like removed or deprecated to me. How about the below under pdb.set_trace() doc and example using it in the beginning?

New in version 3.7: breakpoint() is a convenience function that internally calls pdb.set_trace()

Thanks

Hello,

What about like this
import pdb; pdb.set_trace()
New in version 3.7: breakpoint() is preferable to using the previous line.

Thanks,

JM

I didn't want the doc to sound like breakpoint() is encouraged since it's optional and a shortcut. Hence my personal preference to just add a note with link to breakpoint() that it does the same thing. I will wait for someone else to rephrase it better since I am not a native speaker myself.

Thanks

I agree with Karthikeyan.  If it's added to the pdb doc page, I think the existing text should stay as it is, but a 'New in 3.7' added after it.

Something like:

The typical usage to break into the debugger from a running program is to insert

import pdb; pdb.set_trace()

at the location you want to break into the debugger. You can then step through the code following this statement, and continue running without the debugger using the continue command.

New in version 3.7: The built-in :func:`breakpoint()`, when called with defaults, can be used instead of ``import pdb; pdb.set_trace()``.

Hello,

In my first message I said exactly that (the replacement used the previous text, if you check it).

I'm ok with the wording from Cheryl. How about you Karthikeyan?

Thanks,

JM

I am ok with Cheryl's idea too.

@jcrmatos, would you like to create a Github pull request with the change?

Hello,

I'm sorry, I have no idea how to do it.

JM

@jcrmatos,

No problem.  :-)  If you are interested in learning how, we can guide you.  However, if you'd rather not, then that's OK too and we'll make the patch.  Just let us know which you'd prefer.

If you need help deciding, take a look at the devguide on how to get started.  
https://devguide.python.org/

Thanks!

Hello,

Yes, I'm interested in learning, thanks.
I use Windows not Linux. Is that a problem?
I will read the guide and let you know if I have any questions. Thanks again.

JM

Hello,

I'm using Github web interface.
I did these steps:
- Forked cpython and changed the pdb.rst file.
- Created a branch called "fix-issue-35835".
- Made the commit with description "Add reference to Python 3.7 new function breakpoint()".
- Made the pull request with title "bpo-35835: Add reference to Python 3.7 new function breakpoint()".
- Made the merge commit.

Now I have an option to delete the fix-issue-35835 branch.
Should I do it? I read some Git tutorials and I think I can, but can you confirm?

After that, how should I procede to create the patch?

Thanks,

JM

Hello,

On the previous message I forgot to mention that the pull request was made in my fork, not the cpython repo.
Should I made a PR in the cpython repo at this point?

Thanks,

JM

@jcrmatos yes, you should be making a PR to CPython repo's master branch since GitHub PRs are accepted. I hope also need to sign the CLA for your contribution to get merged though it's a documentation fix.

Thanks

Hello,

Yes, I signed the CLA and now I have to wait at least 1 business day.
So I will wait for that confirmation before making the PR to the CPython repo.

Thanks,

JM

@jcrmatos - Sounds like you're on the right track.  :-)

Based on the steps you've outlined, I just had one question.  Were you able to rebuild the docs locally in order to see how your changes looked?  Here's the direct link to building the docs:
https://devguide.python.org/documenting/#building-doc

In section 7.5.1, it mentions Windows, so you should be able to follow that.  Although, I've had to use `./make html` in Powershell, so if `make html` doesn't work, then try that.

Hello,

I didn't do anything locally. I did the change and preview it on GitHub's web interface.

Has I said, I did a PR to my own fork and now I think I have to do a PR to the cpython master. Is that correct?
The PR to my own fork was required, or the commit was enough?

Now I have an option to delete the fix-issue-35835 branch.
Should I do it? I read some Git tutorials and I think I can, but can you confirm?


Thanks in advance,

JM

As Karthikeyan said, you do need to open a PR against the CPython master.  I'm not a Git expert, but this page (section 3.3) discusses the steps to open that PR:
https://devguide.python.org/pullrequest/

Those are the steps I follow and it's a good write-up so there's not much I can add to it.  I don't think the PR on your own fork was required.  It doesn't usually ask to delete the branch until the PR against CPython master has been merged (which is the last step in section 3.3), but since you merged against your own fork, that's probably why it's asking now.  Do you still get an option to create a PR against CPython master using your branch as per this part of section 3.3?

> Finally go on https://github.com/<your-username>/cpython: you will see a box with the branch you just pushed and a green button that allows you to create a pull request against the official CPython repository.

I deleted the fork and started again.
This time I didn't PR to my own fork but to cpython master.
It is now waiting for review, "skip news" labeling and CLA (I'm still waiting on my request).

New changeset cf991e653ac550a9f011631447c61ce583404a57 by Miss Islington (bot) (João Matos) in branch 'master':
bpo-35835: Add reference to Python 3.7 new breakpoint() function in pdb documentation. (GH-11691)
https://github.com/python/cpython/commit/cf991e653ac550a9f011631447c61ce583404a57

Thanks!

Thank you all for the help.

New changeset 7516f265a8517e4fdc7d6e63d72ae1b57fda26ee by Miss Islington (bot) in branch '3.7':
bpo-35835: Add reference to Python 3.7 new breakpoint() function in pdb documentation. (GH-11691)
https://github.com/python/cpython/commit/7516f265a8517e4fdc7d6e63d72ae1b57fda26ee