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

Doc improvement - Extending and restructuring of the doc tutorials #431

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

juliusroeder
Copy link

In response to #285 and #325 this PR aims to clarify and simplify the tutorials for beginners.
It extends the initial "Writing your first optimisation problem" and merges the "Evolving a population" from the "Basics" section to give one coherent example of how to construct a UDP and solve it.
Let me know what you think.

@juliusroeder juliusroeder marked this pull request as draft May 11, 2020 13:13
@bluescarni
Copy link
Member

@juliusroeder thanks a lot, this is an extremely welcome initiative!

I like the new tutorials, how they are organized and the writing style. I have a minor question about some of the links you added, e.g., .. _cpp_archipelago: on top of archipelago.rst. Is there a specific reason why you added a new reference instead of just referencing directly the archipelago class via :cpp:class:`~pagmo::archipelago` (or similar)?

Another minor comment is that perhaps you could update the comment // Our simple example problem, version 1. in the new tutorials, so that the problem version is updated to 2, 3, etc.

We'll take a deeper look once you feel like the PR is ready, but I am really happy about the direction where this is going.

No documentation yet and needs refactor.
Added small introduction to the tutorial to clarify what pagmo is and what it is not, with possible applications from different domains. 

Switched to the cpp class referencing instead of ".. _cpp_archipelago:"

Updated comments in the tutorial code to reflect version numbers. 

Added initial introduction for bin packing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants