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

Update general_usage.md #107

Merged
merged 4 commits into from
Jun 14, 2024
Merged

Update general_usage.md #107

merged 4 commits into from
Jun 14, 2024

Conversation

engintoklu
Copy link
Collaborator

Extend the general usage docs to mention the status object

Extend the general usage docs to mention the status object
@engintoklu engintoklu added the documentation Improvements or additions to documentation label Jun 14, 2024
Copy link
Contributor

@flukeskywalker flukeskywalker left a comment

Choose a reason for hiding this comment

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

Why is the new text commented out?

@engintoklu
Copy link
Collaborator Author

Why is the new text commented out?

Different ways of analyzing the evolutionary computation results work under different conditions (some of them work only for distribution-based algorithms, some of them cannot work when the algorithm is distributed across actors, etc., some of them will work only if the problem has store_solution_stats enabled, etc.). These conditions are explained in the comments. According to the situation at hand, one can un-comment the code and do the analysis. Iterating over the status keys and values is a piece of code that would always work, so that one is not commented out.

@flukeskywalker
Copy link
Contributor

flukeskywalker commented Jun 14, 2024

Ah sorry I was unclear. What I meant was we could move the text explanation paragraphs out of the code blocks as content into the main text of the page.

Copy link
Contributor

@flukeskywalker flukeskywalker left a comment

Choose a reason for hiding this comment

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

Looks good now

@flukeskywalker flukeskywalker merged commit dcd66dc into master Jun 14, 2024
1 of 3 checks passed
@flukeskywalker flukeskywalker deleted the docs/update-general-usage branch June 14, 2024 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants