sebp / sebp/PyGObject-Tutorial

Feature Request: Additional Clarification on "Simple Example" in "introduction.txt"

Ouverte
#206 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
392
Forks
157
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

I hope this isn't too pedantic as a request, but just reading section 2.1 of the guide from the top, the first statement claims, "This program will create an empty 200 x 200 pixel window."
A graphical representation of such a window is then included.
The page then provides a 9-line program by way of an example, in source code, then follows to "explain each line of the example."

However, nowhere on this page does the text return to the subject of "200 x 200 pixel" sizing. It seems reasonable for the initial declarative statement to explain what is about to happen, but there is nothing in the sample code which defines such a size and it is therefore implied that Python's "Gtk.Window()" method, or perhaps "win.show_all()", must somehow default to these dimensions unless explicitly told otherwise.

If you're going to have a "simple example", can I respectfully request/suggest that the explanatory text be expanded just enough to tell the reader where the window dimensions come from.

I appreciate that this might come across as pedantry, but syntax is critical in programming, so in the early stages of introducing a language or framework, I would suggest that all defaults and assumptions need to be discussed.

This is all the more relevant given the second example on the Introduction Page (the ubiquitous "Hello World" application with the "Click Here" button. Miraculously, the rendered window has changed size. Yet again, there is nothing in the code to suggest window size or why this might be different from the first example. The two examples imply that if you deploy a random, empty window, then it will default to a size of 200x200 pixels, but if you deploy a window that contains an object (your second example uses a button), then the window will automatically size itself to the dimensions of the rendered contents.

None of which is explained.

Even if you want to direct your reader to set this aside, please don't leave hanging threads at the start...

Thank you

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Ouvrez introduction.txt et lisez la section 2.1 avec ses deux exemples de fenêtres. Vérifiez comment le texte décrit actuellement la fenêtre 200 x 200 et la fenêtre Hello World de taille différente ; la documentation est terminée lorsqu’elle explique le comportement de dimensionnement pertinent et les valeurs par défaut sans laisser ces exemples inexpliqués.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.