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.

Sign up for GitHub

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

Jump to bottom

[joss-reviews#2974] Improve API docs #15

Closed
chkoar opened this issue Feb 6, 2021 · 8 comments · Fixed by #55
Closed

[joss-reviews#2974] Improve API docs #15

chkoar opened this issue Feb 6, 2021 · 8 comments · Fixed by #55
Assignees
@sjvrijn @chkoar
Labels
Ready for JOSS review

Comments

@chkoar
Copy link
Contributor

chkoar commented Feb 6, 2021

Related: openjournals/joss-reviews#2974

All functions/methods should be documented including example inputs and outputs and their expected types. This may help you.
@geoffreyp
Copy link
Contributor

Thank you for the tip!
I move the documentation in this repository and I use autodoc with auto-summary.
The documentation is for the moment based on the dev branch at this url https://moead-framework.github.io/framework/

@chkoar
Copy link
Contributor Author

chkoar commented Feb 11, 2021

The documentation needs a great improvement. For instance:

image

@geoffreyp
Copy link
Contributor

The API documentation has been improved in the commit 0e45c0e. All parameters and methods are now explained (type + short description)

@sjvrijn sjvrijn mentioned this issue Mar 29, 2021
Closed
@sjvrijn
Copy link
Contributor

sjvrijn commented Mar 29, 2021

API documentation is missing for the solution and tool folders

@geoffreyp geoffreyp linked a pull request Mar 31, 2021 that will close this issue
update documentation with tools api #55
Merged
@geoffreyp
Copy link
Contributor

The documentation for tools is added in the PR #55
The documentation for solution is available in the section Main Component: https://moead-framework.github.io/framework/html/main_components.html#solution

@chkoar
Copy link
Contributor Author

chkoar commented May 11, 2021

Some links do not work. Check Problem and AggregationFunction here for instance.

@chkoar
Copy link
Contributor Author

chkoar commented May 11, 2021 •
edited by geoffreyp
Loading

  1. There are classes, methods or functions that seem public and they do not contain a docstring. I list some below.
    Please consider adding a descriptive docstring or make them "private" in case that is not intended for public use.
  • AggregationFunction
  • Aggregation.run
  • MoeadDRA.run
  • CrossoverAndMutation.run
  • Crossover.run
  • BinaryMutation.run
  • DifferentialEvolutionCrossover.run
  • MoeadDeOperators.run
  • PolynomialMutation.run
  • OffspringGeneratorGeneric.run
  • ParentSelector.run
  • OneRandomAndCurrentParentSelector.select
  • TwoRandomAndCurrentParentSelector.select
  • TwoRandomParentSelector.select
  • SpsStrategy
  • SpsAllSubproblems.get_sub_problems
  • MaxEvaluation.test
  • KnapsackProblem.f
  • KnapsackProblem.generate_random_solution
  • Mubqp.generate_random_solution
  • Rmnk.f
  • Rmnk.generate_random_solution
  • Problem
  1. It should be nice to include some execution examples in the class docstrings.

@geoffreyp
Copy link
Contributor

The PR #55 is updated

@sjvrijn sjvrijn mentioned this issue May 27, 2021
Closed
@chkoar chkoar closed this as completed Jul 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sjvrijn sjvrijn

@chkoar chkoar

Labels
Ready for JOSS review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update documentation with tools api geoffreyp/framework
3 participants
@sjvrijn @geoffreyp @chkoar