Skip to content

Conversation

csabella
Copy link
Contributor

@csabella csabella commented Jan 14, 2018

In the help_about module of IDLE, convert text that contained URLs to be clickable links.

https://bugs.python.org/issue32548

Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

Note that IDLE already has the capability of browsing off-line copies of the Python documentation that are installed locally on the system (for example, when using the macOS python.org installer version), with fallback, if necessary, to the online version. It would be better, I think, to do the same here so as not to introduce an unnecessary dependency on being online. See the EditorWindow class in Lib/idlelib/editor.py for the existing code.

@csabella
Copy link
Contributor Author

@ned-deily Thank you for your review. I had seen that code in EditorWindow and I wasn't sure if I should include it in this PR or not. The URL link for the docs already existed on the Help -> About screen and I just changed it from being plain text to being blue, underlined, and clickable. I was attempting to introduce the functionality [of a hyperlink] without changing the dialog too much in order to make the PR more reasonable to review.

Do you think that your request should be introduced here or in a subsequent PR?

Thanks!

@terryjreedy
Copy link
Member

The EditorWindow.python_docs method is linked to the 'Python Docs F1' entry on the Help menu. (The function, the help_url code wrapped as a function, and the link code should be moved to the help module.) The 'IDLE Help' entry is linked to a no-trailing-whitespace copy of the IDLE .html page in the docs. (Would 'IDLE Doc' be clearer?) The point of the copy is to avoid an online dependency.

The link in About IDLE, to the online copy of the IDLE .html page, is now redundant with the latter and perhaps should be removed. Or it should open the local copy, the same as IDLE Help'. It was less redundant when 'IDLE Help' linked to a separate plain text within idlelib.

Before adding idlelib/help.html and the custom html parser, I looked into opening the IDLE page within a possibly off-line system-dependent copy of the docs, and preferred the completely self-contained solution. I would still like to have making the filtered copy be part of the release process, but that is a separate issue.

@csabella
Copy link
Contributor Author

@terryjreedy I removed the doc link for the About page, so you could see what it looked like. I also changed create_link to take a callback instead of just a link so that it would be easier to change the buttons to use it. Based on your comments about using online browser, I added a message box to display_browser_link in case the browser couldn't be opened. I'm not sure if there's a better way to include the link to the webpage for the Email List.

@terryjreedy
Copy link
Member

The mailing list link works fine, but now that I am effectively the list owner, I want to edit the page before sending people there. I also want to drop other buttons or convert to links also. I decided not to rush this for 3.7.0rc1.

@csabella csabella closed this Jun 4, 2018
@csabella csabella deleted the help branch June 4, 2018 17:24
@csabella
Copy link
Contributor Author

csabella commented Jun 4, 2018

Well, that was unintentional. :-( I was trying to clean up branches and didn't know which ones were still open. I'll need to figure out how to recreate this.

@ned-deily
Copy link
Member

@csabella If the branch had been pushed to your GitHub clone in the cloud, you may be able to undelete the branch by going to your GitHub clone page and clicking on the Branches page. Good luck!

@terryjreedy
Copy link
Member

terryjreedy commented Jun 4, 2018

I gather that you deleted the branch on your clone that was the basis for the PR and github closed the PR. I have been wondering if that would be the result of such a deletion ;-).

I cannot reopen, which I expected. I can create a local branch from the PR, which I mostly expected because the Files changed button still works to show the diff. And yes, I still intend to review this.

@csabella csabella restored the help branch June 4, 2018 18:00
@csabella csabella reopened this Jun 4, 2018
@csabella
Copy link
Contributor Author

csabella commented Jun 4, 2018

Thanks, @ned-deily and @terryjreedy. I was able to recover this one and the other PR by following the second response at:
https://stackoverflow.com/questions/33656729/how-to-recover-a-deleted-remote-branch

Luckily, it was actually not too difficult.

What I done to cause the issue:
git push origin --delete branch_name

I built a new computer last week, so I had recreated my local clone. The git branch was so nice and uncluttered that I thought I'd do the same on my csabella origin remote at github. Lesson of the day: if you do that on open PRs, it deletes the branch and closes the PR. :-) At least github had the commits, so I was able to use that to recreate the branch. :-)

@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Aug 14, 2022
@terryjreedy
Copy link
Member

I have since tested the mail url and it works. However, I think I would like to have that button open a dialog that says something about how to report bugs and ideas.

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Aug 15, 2022
@hauntsaninja hauntsaninja changed the title bpo-32548: IDLE: Convert labels to hyperlinks in help_about gh-76729: IDLE: Convert labels to hyperlinks in help_about Jan 7, 2023
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review stale Stale PR or inactive for long period of time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants