close Warning: Can't synchronize with repository "(default)" (/var/svn/mms does not appear to be a Subversion repository.). Look in the Trac log for more information.

Opened 14 years ago

Last modified 13 years ago

#600 accepted task

Documentación/Descripción de los métodos de las clases de MMS

Reported by: imendez Owned by: Pedro Gea
Priority: major Milestone: Next
Component: Documentation Keywords:
Cc:

Description

Hola, la inmensa mayoría de los métodos de las clases de MMS no contienen una descripción. Así ocurre, por ejemplo, con los métodos de la clase @Estimation:

Clear, Delete, Duplicate, Execute...

Sería muy útil saber para que sirvan sobre todo porque hay algunos métodos con un nombre similar que, para quien no los conoce, pueden resultar difíciles de distinguir. Por ejemplo, ¿cuál es la diferencia entre SetStrategy, SetStrategy_Spc y SetStrategy_Spc0.5?

Un saludo.

Change History (2)

comment:1 Changed 14 years ago by Pedro Gea

Milestone: → Release 0.6
Status: new → accepted
Type: defect → task

Es cierto que los métodos no presentan descripción aunque intentan seguir algunas reglas para facilitar su comprensión.

Este caso del uso del guión bajo incluso se comenta en la documentación sobre las clases en MMS. El método diseñado para el usuario es SetStrategy, mientras que los otros dos son dos variantes (de ahí el uso del guión bajo) que reciben como argumento la especificación (Spc) con la que se almacenan esos objetos, en la versión actual (SetStrategy_Spc) o en la versión 0.5 (SetStrategy_Spc.0.5). Quizá el problema es que no se pueden ocultar esos métodos (de uso interno) a los usuarios y evitar así que se cuestionen su existencia.

De todos modos, tenemos la intención de intentar paliar algunas de estas carencias, aunque pueda ser algo costoso. También me preocupa que páginas de la wiki como la que enlazo antes no llegan a los usuarios.

comment:2 Changed 13 years ago by Pedro Gea

Milestone: Release 0.6 → Next
sensitive: → 0
version: 0.6
Note: See TracTickets for help on using tickets.