Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Docs don't mention when a class method is considered private v.s public / --help behavior is confusing

Abierto
#531 2 comentarios 1 reacción 0 asignados Ver en GitHub

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
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
cli, documentation

Línea de trabajo

Comienza con el MWE de Python Fire del issue y compara el comportamiento sin argumentos, con --help y con --verbose descrito allí. Actualiza la documentación relevante para explicar cuándo los métodos de una clase se exponen como públicos o privados y por qué estas invocaciones de ayuda difieren. La tarea estará terminada cuando una persona nueva pueda determinar cómo hacer público un método y comprender el comportamiento documentado de --help.

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

Descripción

Here's a MWE:

#!/usr/bin/env python

from fire import Fire

class Example:
    def version(self):
        return "bla"
    def start(self):
        print("starting")
    def stop(self):
        print("stopping")

Fire(Example)

Running this script without arguments shows the available commands - OK:

NAME
    fire-bug.py

SYNOPSIS
    fire-bug.py COMMAND

COMMANDS
    COMMAND is one of the following:

     start

     stop

     version

But the more common (and usually safe) thing to do when a user is being introduced a new command, is to run it with a --help. However, Fire doesn't behave the same for this argument:

INFO: Showing help with the command 'fire-bug.py -- --help'.

NAME
    fire-bug.py

SYNOPSIS
    fire-bug.py -

Unless you use --verbose as well. Why is that? This is not trivial for a user to guess, and only reading the docs here led me to this conclusion. Plus, the docs don't mention how to make a class method a "public" method...

Lenguaje dominante
Python
Estrellas
28.2k
Forks
1.5k
Sin PR fusionados en 30 d

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.

Más de google/python-fire

Todos los issues de google/python-fire

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.