python / python/cpython

Improve the frozenset.is(sub|super)set docstrings

Abierto
#129,622 10 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Documentation

RE: Documentation provided by built-in function help()

While reviewing built-in methods in detail I made note of:

  • "help(frozenset)" issubset and issuperset methods both return bool type
Other comments that were not issues

See https://github.com/python/cpython/issues/129622#issuecomment-2633394435.

  • "help(slice)" third parameter typo
  • "help(range)" third parameter typo
  • "help(float)" quizzical hex method example
  • "help(bool)" is bit_length method also for absolute value of self?
  • "help(bool)" is_integer appears duck-like compatible with int (TypeError with float)
  • "help(bool)" from_bytes appears to return a bool from byte array

Regards,
'EntryLevelJobSeeker'

Linked PRs
  • gh-129637

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza ejecutando help(frozenset) y revisando los docstrings de issubset e issuperset en el código fuente de CPython. Compara su redacción con el comportamiento de retorno bool de los métodos; la documentación estará terminada cuando ambos docstrings describan con precisión ese resultado. El PR vinculado gh-129637 indica que ese trabajo ya está en curso.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.