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

Add page explaining the structures of CGP to documentation #223

Merged
merged 1 commit into from
Aug 12, 2020

Conversation

mschmidt87
Copy link
Member

This PR adds a page explaining the structures of CGP in our library. It is based on #220 , so only look at population_individual.rst. .

@mschmidt87 mschmidt87 requested a review from jakobj August 2, 2020 05:11
@mschmidt87 mschmidt87 added the doc Improvements or additions to documentation label Aug 2, 2020
@jakobj jakobj added this to the 0.2.0 milestone Aug 4, 2020
Copy link
Member

@jakobj jakobj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, this looks great! i've added a few comments inline

i am assuming this is mainly to give a high-level overview for the user to become familiar with the concepts, isn't it? one thing that i am (as always) worried about is maintainability. we should try to keep these descriptions as far away as possible from the implementation to avoid having contradictory information here and in the source code (same applies to the local search docs).

docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
Copy link
Member

@jakobj jakobj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking good, just three more small comments

docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
docs/details/population_individual.rst Outdated Show resolved Hide resolved
Copy link
Member

@jakobj jakobj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, thanks! 👍

waiting for #220 to be merged first. then please rebase and squash.

@jakobj jakobj changed the title Doc/cgp structure Add page explaining the important structures of CGP Aug 11, 2020
@jakobj jakobj changed the title Add page explaining the important structures of CGP Add page explaining the structures of CGP to documentation Aug 11, 2020
@jakobj
Copy link
Member

jakobj commented Aug 11, 2020

please resolve conflicts introduced by merging #220

@mschmidt87 mschmidt87 merged commit ccfef4f into master Aug 12, 2020
@mschmidt87 mschmidt87 deleted the doc/cgp_structure branch August 12, 2020 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants