Python Forum
features examples by release
Thread Rating:
  • 1 Vote(s) - 1 Average
  • 1
  • 2
  • 3
  • 4
  • 5
features examples by release
#1
I develop Python features examples by release:
https://github.com/makelinux/examples/bl.../README.md

Most valuable features of each python release are demonstrated in separated file with unit testing. For example https://github.com/makelinux/examples/bl...hon/3.5.py demonstrates features of Python 3.5.

Welcome to review, use and update.
Reply
#2
How your examples are better than the one in the official docs? I know that not every new method has an example, but it's not always necessary.
Some problems that need to be fixed:
star imports
single-char variable names
e.g. in 3.9 you overwrite the built-in sum function, probably similar mistake is present elsewhere.
no documentation/explanations (i.e. only link to official docs, which again brings to the question why and what's benefit compared to docs)
imports at the end of file - I understand what you do, but you should not relay on executing passed module during the import, that's bad design
just importing new modules, how does demonstrate the new features in them?
If you can't explain it to a six year old, you don't understand it yourself, Albert Einstein
How to Ask Questions The Smart Way: link and another link
Create MCV example
Debug small programs

Reply
#3
Thank you for the feedback!

I've fixed the code accordingly all your notes.

(Aug-31-2020, 04:31 AM)buran Wrote: How your examples are better than the one in the official docs?

Features of examples:
  • Minimal and practical self descriptive as possible source code.
  • Complete and ready to copy-paste into an application.
  • Runnable in-place. (No need to copy paste snippets from documentation into an interpreter)
  • Verifiable. Internal tests provides reliability and durability. You can easily add new features and run tests to assure code validity.

Reply


Possibly Related Threads…
Thread Author Replies Views Last Post
  Key features of Python Frameworks JahnviK 0 731 Sep-24-2022, 06:09 AM
Last Post: JahnviK
  Python 3.9.11 release? raghupcr 3 2,019 Mar-17-2022, 07:17 AM
Last Post: raghupcr
  examples using os.walk() Skaperen 12 6,990 Mar-22-2021, 05:56 PM
Last Post: Skaperen
  What are the key changes in dotenv-linter v3.0.0 release? elizabethlvova 0 1,649 Jan-28-2021, 02:35 PM
Last Post: elizabethlvova
  pygame 2.0 - the happy dance birthday release snippsat 1 1,789 Oct-30-2020, 02:37 PM
Last Post: metulburr
  Python Going to a 12 Month Release Cycle ichabod801 0 1,439 Nov-01-2019, 08:32 PM
Last Post: ichabod801
  list of compliances of all special methods - examples nzcan 2 2,724 Sep-01-2018, 08:33 PM
Last Post: Windspar
  How do I properly release my code open-source? Brennan 1 2,533 Jun-30-2018, 12:33 PM
Last Post: snippsat
  PyCharm Early Release 2018.1 EAP now available Larz60+ 0 3,020 Jan-21-2018, 08:46 PM
Last Post: Larz60+
  Interesting new features in python3 Kebap 8 5,824 Jul-05-2017, 03:53 PM
Last Post: nilamo

Forum Jump:

User Panel Messages

Announcements
Announcement #1 8/1/2020
Announcement #2 8/2/2020
Announcement #3 8/6/2020