Introduction of # comments in E2
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Abre la lección del Episode 2 en la URL enlazada y localiza la sección “Introduction to Python built-in data types” y la discusión posterior sobre scripts. Revisa dónde aparece la explicación existente sobre # comment y mueve la explicación introductoria relevante al primer ejemplo, conservando la discusión posterior sobre scripts; se considera completado cuando los comentarios se explican la primera vez que aparecen.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I recently taught a demo of Episode 2: Short Introduction to Programming in Python
https://datacarpentry.org/python-ecology-lesson/01-short-introduction-to-Python/index.html
Under Introduction to Python built-in data types, comments are introduced but not yet explained:
Python
text = "Data Carpentry" # An example of a string
number = 42 # An example of an integer
pi_value = 3.1415 # An example of a float
I found myself explaining the # comments here, though they are explained a little further down in this section:
Python:
# A Python script file
# Comments in Python start with #
# The next line assigns the string "Data Carpentry" to the variable "text".
text = "Data Carpentry"
# The next line does nothing!
text
# The next line uses the print function to print out the value we assigned to "text"
print(text)
I was wondering if it may make sense to pull out some of the explanation and move to where comments are first introduced? Perhaps even just # Comments in Python start with # and leave the rest, as it makes sense with the script discussion?
Thanks!
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 176
- Forks
- 316
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de datacarpentry/python-ecology-lesson
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Reducing "read in" jargonAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
-
Lowercase "p" in "pandas"Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
Todos los issues de datacarpentry/python-ecology-lesson
Issues similares
-
Broken links in the docsAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
microsoft/onnxruntime#33018 ·
Los mantenedores suelen responder en 2 días
-
missing content writing algorithms
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
QuantConnect/Documentation#2739 ·
Los mantenedores suelen responder en 1 día
-
:watch: Not Triaged dotnet-target-version
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
copilot documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 2 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
lichess-org/api#678 ·