python / pythondotorg

Source code for python.org
https://www.python.org
Apache License 2.0
1.47k stars 587 forks source link

Front-page code example wording #1637

Open 8vasu opened 3 years ago

8vasu commented 3 years ago

When https://www.python.org/ is visited, the user is presented with sample code that says "# Python 3: Fibonacci series up to n...". A "series" is a limit of a sum. This should be changed to "# Python 3: Fibonacci sequence up to n...".

aeros commented 3 years ago

This was roughly posted by me earlier on the core-mentorship ML thread where this was originally brought up, but I'll go into a bit more detail here.

I can agree that the example on the front of python.org may not perfectly fit the mathematical definition of a "series" ("a limit of a sum"). However, it's worth also considering the more casual/commonplace definition of "series", which is likely what the example was using:

According to Mariam-Webster, a series can be defined as "a number of things or events of the same class coming one after another in spatial or temporal succession".

While the specific mathematical definition is generally more relevant in an academic context and some engineering fields, in the context of a very broad example that's targeted at potential first-time Python users, I think the more casual definition is perfectly suitable. More importantly, I don't think that changing "series" -> "sequence" would significantly benefit that target audience.

(It wouldn't necessarily hurt them either, but it requires a tangible practical benefit to justify making the change to a front page example. I'm personally not seeing that benefit.)

aeros commented 3 years ago

Also, I'd suggest making the title of the issue a bit more specific, e.g. "Front-page code example wording" or something along those lines. "Wording bug" could refer to any page on python.org.

8vasu commented 3 years ago

I understand what you mean. This was just a suggestion. You may close this if you think it is unnecessary trouble.

aeros commented 3 years ago

I'm actually unable to close the issue in pythondotorg, as the website is considered outside of the "python core repositories". But, it doesn't hurt to have a second opinion here.

Regardless of the eventual outcome of the issue, thanks for investing your time in making a suggestion. It's appreciated either way. :-)

8vasu commented 3 years ago

:)