Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change alg summary strings to a single setSummary #10366

Closed
peterfpeterson opened this issue May 22, 2014 · 1 comment
Closed

Change alg summary strings to a single setSummary #10366

peterfpeterson opened this issue May 22, 2014 · 1 comment
Assignees
Labels
Framework Issues and pull requests related to components in the Framework High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Milestone

Comments

@peterfpeterson
Copy link
Member

This ticket is blocks : TRAC8365, TRAC9249, TRAC9326, TRAC9390, TRAC9509, TRAC9511

We have several methods for documenting alg Algorithm::getOptionMessage, Algorithm::getWikiSummary and an unused alg::getWikiDescription. This is confusing and are badly named. Change this to only have a single summary method.

This is critical as it is linked to the migration of the algorithms to the new documentation approach.

@peterfpeterson
Copy link
Member Author

This issue was originally trac ticket 9523

@peterfpeterson peterfpeterson added High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Framework Issues and pull requests related to components in the Framework labels Jun 3, 2015
@peterfpeterson peterfpeterson added this to the Release 3.2 milestone Jun 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues and pull requests related to components in the Framework High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Projects
None yet
Development

No branches or pull requests

2 participants