Cursos Empresas Blog Live Conf Precios

¿Qué es la documentación?

Clase 3 de 21 • Curso de Python Intermedio: Comprehensions, Lambdas y Manejo de Errores

Clase anteriorSiguiente clase

Carlos Eduardo Gomez García

teacher•

La documentación es la biblia de cualquier programador. . No puedes aspirar a aprender un lenguaje si no lees documentación. Sé que muchas personas se saltan eso porque piensan "ufff, es mucho texto, se ve feo", etc. Pero es la documentación quien nos va a decir exactamente cómo funciona el lenguaje (y cualquier tecnología). No hay un solo desarrollador profesional que no lea documentación. . ¡Y claro!, con esto no quiero decir que tengas que estar metido en la documentación siempre, pero quiero que sepas que la vas a consultar muchas veces cuando tengas problemas <3. . En ese paso de programador novato a programador profesional se encuentra aprender a consultar documentación, da el paso, no le temas a la documentación, es tu mejor amiga :D.

Said Leonardo

student•

No hay día que que no consulte documentación, sobre todo porque estoy comenzando aprender Django y su documentación es jodidamente buena, te hace coquetear con lo básico para luego empaparte con todo su ecosistema.

Miguel Andres Rendon Reyes

student•

Leer es prácticamente la base de cualquier disciplina, un ejercicio chévere para los que no les gusta leer, es que se traten de imaginar como el Dr Strange cuando estaba aprendiendo. Leía y aprendía todo el tiempo y programar es como hacer mágia, es un poder increible, así que tu eres el próximo Dr Strange por estar leyendo

Nicolas Adrian Battista

student•

Buenas, pase toda la documentacion a un pdf, asi la imprimo y la leo tranquilo. Les dejo el link, por si les interesa descargarla.. saludos [(https://drive.google.com/file/d/1dSYgA7Xonw1XLMcjrsMXSqDUWLlqi-57/view?usp=sharing)

Miguel Andres Rendon Reyes

student•

Uff, re bueno amigo

Rubén David Pérez Cantillo

student•

👏🏻Muchass graciass, bro. Voy de una a imprimirla

Jose Antonio Rojas Ollarves

student•

❗Top 🔟 Beneficios de leer la documentacion de python📝 . .

Consultar informacion clara y directa 2. Tener ejemplo de los mismos desarrolladores 3. Referencias de todas las caracteristicas y funcionalidades en un solo lugar 4. Conocer los nuevos features de nuevas actualizaciones 5. Conocer el modo de empleo de versiones anteriores 6. Aprender a manejar correctamente las herramientas 7. Que contienen los modulos integrados dentro de python 8. Como manejar los modulos 9. Manejo y uso de frameworks 10. Ser autodidacta

. . Link de documentacion: Documentacion python

Moisés Manuel Morín Hevia

student•

Estoy de acuerdo!!

Mauricio Gonzalez Falcon

student•

Gracias por tu aporte!

Jonathan Edwin Gutiérrez Olvera

student•

Me gustaría compartirles una herramienta por si no les gusta leer la documentación desde la página o prefieren ir documentándose mientras programan 😉 les recomiendo que usen Kite que les brinda la documentación de cada función que escriban en su código con solo poner el cursor encima. Yo la ocupo bastante y me ayuda mucho mientras programo. 😁

Augusto Borromeo

student•

Gracias por compartirlo! 😊

Jose Colmenares

student•

Yo la utilizo constantemente. Es bastante buena

Omar Daniel Centeno

student•

Conocer la historia del lenguaje 🤩

Una parte que me llamó la atención fue la de historia y licencia. Por cierto, en mayo es la conferencia principal de la Python Software Foundation y aunque es de paga después se pueden ver muchas de las ponencias en Youtube.

También es muy importante conocer la guía de estilo, conocer y aplicar las buenas prácticas para que al trabajar con más personas podamos leer el código de manera sencilla y entendible. Esto se relaciona también con el Zen de Python que acabamos de ver.

Miguel Andres Rendon Reyes

student•

Gracias por el consejo Bro.

Moisés Manuel Morín Hevia

student•

Buena !!

Antonio Demarco Bonino

student•

Esta va a ser la primera documentación que voy a leer en mi vida.

Moisés Manuel Morín Hevia

student•

Espero la leas toda.

Sebastian Castañeda Garcia

student•

Cuando queremos definir argumentos por defecto en una función, no debemos usar espacio entre el signo "=" y su nombre o su valor.

# Correct:
def complex(real, imag=0.0):
    return magic(r=real, i=imag)
# Wrong:
def complex(real, imag = 0.0):
    return magic(r = real, i = imag)

Paula Scatarelli

student•

soy muy del espacio gracias por el detalle!

Andres Felipe Zabala velez

student•

Buen detalle gracias.

Eber Laurente Lliuyacc

student•

Descubrí que de hecho el Zen de Python es el PEP N°20 :)

https://www.python.org/dev/peps/pep-0020/

Moisés Manuel Morín Hevia

student•

xD Qué curioso porque tiene 19 principios

Henrry Lara

student•

que es el Pep?

Tania Michelle Rubí Rojas

student•

¿Romper la línea antes o después de un operador binario? En cada lenguaje de programación me encuentro con el mismo problema: no saber dónde romper la línea de mi código. Generalmente lo hacía después, pero después de leer este articulito https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator

cambié de opinión. Romper la línea del código antes del operador facilita mucho la lectura del código. En Python se puede romper antes o después, siempre y cuando seamos consistentes con esta forma de romper el código :D

Cynthia Rojas Rivera

student•

Genial <3

Fernando Elías Díaz Acosta

student•

¡Interesante!

Juan Antonio Aramburo Pasapera

student•

Algo interesante de nuevo en python 3.9 es que ahora se pueden unir diccionarios con el operador | entonces en lugar de hacer d1.update(d2) puedes usar

d1 |= d2

ó

d3 = d1 | d2

Andrés Felipe Sierra Álvarez

student•

¿Tabs o Espacio?

A criterio personal siempre he usado y preferido tab para organizar mi código, sin embargo, la documentación de Python dice que es preferible usar espacio para la sangría o indentación de ésta.

Intentaré hacer caso a la documentación y usar más el tab

Orlando Reyes

student•

Será usar menos tab no?

Cesar Gabriel Mejias Farreras

student•

Ya leí la documentación y yo también prefiero la tabulación pero bueno... habrá que usar dos espacios :(

Por cierto al final te confundiste escribiendo, cierto?

Antonio Luis De las Salas Castro

student•

en la documentacion pep 08 , forma correcta de importar.

correcta:

import os
import sys

inconrrecta:

import sys , os

Miguel Andres Rendon Reyes

student•

Okay, gracias por la aclaración Bro

Sergio Iván Piñón Peña

student•

Comentarios Los comentarios que contradicen el código son peores que ningún comentario. ¡Siempre tenga la prioridad de mantener los comentarios actualizados cuando cambie el código!

Los comentarios deben ser oraciones completas. La primera palabra debe escribirse en mayúscula, a menos que sea un identificador que comience con una letra minúscula (¡nunca altere el caso de los identificadores!).

Los comentarios en bloque generalmente consisten en uno o más párrafos construidos a partir de oraciones completas, y cada oración termina en un punto.

Debe utilizar dos espacios después de un período de finalización de una oración en los comentarios de varias oraciones, excepto después de la oración final.

Asegúrese de que sus comentarios sean claros y fácilmente comprensibles para otros hablantes del idioma en el que está escribiendo.

Codificadores de Python de países que no hablan inglés: escriba sus comentarios en inglés, a menos que esté 120% seguro de que el código nunca será leído por personas que no hablen su idioma.

Andres López

student•

Muy útil lo que dices de los comentarios, no lo sabía

Diaz Mauricio

student•

Que buen comentario

Usuario anónimo

user•

📑 La documentación es como un diccionario o manual de Python. Nos permitirá seguir buenas practicas.

Isay Humberto Lucas Hernandez

student•

Hola!

¿Sabían que google tiene su propia guía de estilos para Python? Les comparto aquí el link con la documentación Google Python Style Guide

Es común que las empresas usen estilos propios para escribir o desarrollar su código, esto permite crear un estándar entre todos los desarrolladores facilitando su lectura, comprensión y curva de aprendizaje 😁

Enrique Angeles

student•

Exclente info, muchas gracias Saludos

Jaime Andrés Quiñones Chacón

student•

Aquí les dejo el documento PEP 8 -- Style Guide for Python Code en la versión de español

-PEP 8 - Spanish: https://recursospython.com/pep8es.pdf

Lucas Yañez

student•

Estan los codigos traducidos tambien, tergiversa toda la información.

William Harrisson Barsaya Gómez

student•

No compare los valores booleanos con Verdadero o Falso usando ==:

# Correct:
if greeting:

# Wrong:
if greeting == True:

Peor:

# Wrong:
if greeting is True:

Esta aclaración me pareció muy importante para los programadores novatos que suelen cometer estos errores.

MILENKA CHALLCO MENDOZA

student•

gracias recién empiezo todo

Henrry Lara

student•

el por qué sería? se sobre entiende que LA CONDICIÓN. es ser igual a True

Said Leonardo

student•

Yo uso Nvim para programar en python, y mi auto completado es Kite (esta disponible para otros editores de código). Lo uso porque me permite de manera rápida ir a la documentación de cualquier cosa, me provee ejemplos de como utilizar lo que estoy buscando sin yo tener que abrir el navegador es muy potente lo recomiendo bastante. :)

Miguel Ángel Ramón Candia

student•

Investigue un poco y encontré una herramienta llamada autopep8 y lo que hace es formatear nuestro código siguiendo las reglas de pep8. Espero les interese :)

se instala con pip: pip install autopep8 y luego con el siguiente comando se transforma nuestro archivo: autopep8 --in-place --aggressive --aggressive <filename>

Dejo su documentación: https://pypi.org/project/autopep8/ y la página en donde lo descubrí: https://programmerclick.com/article/58171335885/

Pablo Andres Muñoz Martinez

student•

interesante, gracias por compartirlo.

Jose Luis Quintero Sanchez

student•

Thanks for sharing.! This is so helpful for beginners

Nicolas Contreras Ilabaca

student•

Esto es un problema que muchas personas tienen (Tenemos). Leer lo encontramos aburrido y nos cuesta aún más cuando son cosas "aburridas" pero para mi (Que odio leer cosas aburridas) ha sido todo un descubrimiento empezar a leer documentación. Cada línea te abre la puerta a más líneas y prácticamente se vuelve una adicción leer documentación para saber que más hay o que más puede hacer Python.

Lean documentación y verán incluso que estarán algunos pasos adelante a otros y podrán postular a trabajos mejores.

Saludos compañeros!