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

Improve documentation #124

Merged
merged 12 commits into from
Nov 23, 2022
Merged

Improve documentation #124

merged 12 commits into from
Nov 23, 2022

Conversation

N-Wouda
Copy link
Owner

@N-Wouda N-Wouda commented Nov 23, 2022

Closes #123. See there for an overview of tasks.

@N-Wouda N-Wouda added the documentation Improvements or additions to documentation label Nov 23, 2022
@codecov
Copy link

codecov bot commented Nov 23, 2022 •
edited

Codecov Report

Merging #124 (b0b4d09) into master (31d4bee) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #124   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           28        28           
  Lines          668       668           
=========================================
  Hits           668       668
Impacted Files Coverage Δ
alns/accept/RecordToRecordTravel.py 100.00% <ø> (ø)
alns/accept/SimulatedAnnealing.py 100.00% <ø> (ø)
alns/select/RouletteWheel.py 100.00% <ø> (ø)
alns/select/SegmentedRouletteWheel.py 100.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@N-Wouda N-Wouda requested a review from leonlan November 23, 2022 12:16
@N-Wouda
Copy link
Owner Author

N-Wouda commented Nov 23, 2022 •
edited

@leonlan I'm done! The docs are much more complete now, and that should hopefully help users get started even easier.

The examples are back in the top-level examples/ directory, which makes much more sense IMHO.

leonlan
leonlan reviewed Nov 23, 2022
View reviewed changes
alns/select/RouletteWheel.py Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/setup/contributing.rst Outdated Show resolved Hide resolved
docs/source/setup/contributing.rst Outdated Show resolved Hide resolved
alns/accept/SimulatedAnnealing.py Show resolved Hide resolved
examples/alns_features.ipynb Outdated Show resolved Hide resolved
@N-Wouda
Copy link
Owner Author

N-Wouda commented Nov 23, 2022

@leonlan thanks! The new commit should fix these issues.

@N-Wouda N-Wouda requested a review from leonlan November 23, 2022 20:39
@N-Wouda
Copy link
Owner Author

N-Wouda commented Nov 23, 2022

@leonlan see the caching kicking in on that last run? 40s across the board! Pretty happy about that :)

@leonlan
Copy link
Collaborator

leonlan commented Nov 23, 2022

@leonlan see the caching kicking in on that last run? 40s across the board! Pretty happy about that :)

Yea looks solid! 😃

@N-Wouda N-Wouda merged commit cf3412d into master Nov 23, 2022
@N-Wouda N-Wouda deleted the documentation branch November 23, 2022 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonlan leonlan leonlan approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation
2 participants
@N-Wouda @leonlan