Correct the documented phi-function recurrence join

Abierto Apto para principiantes
#627 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
90/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Lee la introducción del módulo en src/solprop/backends/exponential.py junto con PHI_JOIN = 3.0 y la justificación existente. Corrige las tres desigualdades de la descripción general para que coincidan con la unión en 3, conservando la derivación y la justificación de la calificación. Se considerará terminado cuando la descripción general y la implementación coincidan y se superen las comprobaciones de ortografía y documentación del archivo modificado.

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

Descripción

documentation priority: low

What happens

The module introduction in src/solprop/backends/exponential.py describes a near/far split at |x| = 8, while the implementation's PHI_JOIN is 3.0 and its detailed rationale describes the split at 3. The near-series and far-recurrence inequalities therefore disagree within the same file.

Why it matters

The module is the numerical reference for other backends. Its stale overview can cause an implementing backend to use a different numerical branch domain.

Reproduction

Read, not a numerical run: compare the introductory near/away bullets with PHI_JOIN = 3.0 and its docstring in the inspected source. The constant and detailed rationale agree with the implemented split; the introduction does not.

Context

Found during SEP 48 implementation #611, tracking #608. This is a documentation correction, with no proposed change to coefficients, arithmetic or defaults.

To do

  • Correct all three overview inequalities to match PHI_JOIN.
  • Retain the existing derivation and qualification rationale.

Done when

The overview and implementation consistently describe the join at 3; changed-file spelling and documentation checks pass.

Lenguaje dominante
Python
Estrellas
3
Forks
3
Merge medio
8 h 28 min
PR fusionados (30 d)
176

Preparar el entorno

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 LupoLab/solprop

Todos los issues de LupoLab/solprop

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.