Update documentation toolchain so that it compiles again #480
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…gnoring other chars)
…ded setting to SetRange()
This reverts commit be762e7.
emilydolson
added a commit
that referenced
this pull request
Jun 12, 2023
mmore500
reviewed
Jul 19, 2023
There was a problem hiding this comment.
The draft documentation can be viewed here https://empirical--480.org.readthedocs.build/en/480/
The main topic we need to decide on is how tightly we want to strip out changes unrelated to documentation.
If we want to have this PR be strictly doc-related, mostly nonfunctional changes only, there will be some diffs that need to get ripped out.
I labeled a few diffs that look like they might have leaked in from other work.
Miscellanea:
- Do we want to link here in the side bar?
- Is disabling the "namespace" component of this page or moving it to the end very hard to do? May be worth considering.
- Do we want to keep "Page Hierarchy" here. The todo and deprecated lists are useful. But I think this is kind of a weird way to open the API section.
- we probably should update the example file header docstring on this page
- do we want to update anything on this page given the extensive documentation overhaul we've done? It might be worth brain dumping some how things are now working behind the scenes for posterity while we still remember.
Additional, non-necessary clean up that might be nice:
- Do we want to add subheadings to this page
- do we want to make the checklist on this page
an issue template? - the formatting is weird in this section (missing boldness and list bullet points)
- some of the "using Empirical" pages are API documentation and some are free-form verbal overviews. What is the goal to have in here? Should we replace the manual API documentation with stubs? For example, https://empirical--480.org.readthedocs.build/en/480/library/io/io.html.
- Were tool tips a goal of this PR? I'm not seeing any on the PR build on Firefox/Ubuntu.
| } | ||
|
|
||
| /// Returns the total number of times a mutation of type @param type |
| @@ -1089,7 +1089,7 @@ namespace emp { | |||
|
|
|||
| template <size_t NUM_BITS, bool ZERO_LEFT> | |||
| bool BitArray<NUM_BITS,ZERO_LEFT>::Get(size_t index) const { | |||
| emp_assert(index >= 0 && index < NUM_BITS); | |||
| emp_assert(index < NUM_BITS); | |||
There was a problem hiding this comment.
inadvertently leaked-in off topic diff?
| @@ -1026,7 +1026,7 @@ namespace emp { | |||
| const size_t from_bit | |||
| ) { | |||
| // Only check for same-ness if the two types are the same. | |||
| if constexpr (FROM_BITS == NUM_BITS) emp_assert(&from_array != this); | |||
| if constexpr (FROM_BITS == NUM_BITS) { emp_assert(&from_array != this); } | |||
There was a problem hiding this comment.
inadvertently leaked-in off topic diff?
| for (size_t i = 0; i < NUM_BITS; i++) Set(i, bitset[i]); | ||
| return *this; | ||
| } | ||
|
|
||
| /// Assignment operator from a string of '0's and '1's. | ||
| template <size_t NUM_BITS, bool ZERO_LEFT> | ||
| BitArray<NUM_BITS,ZERO_LEFT> & | ||
| BitArray<NUM_BITS,ZERO_LEFT>::operator=(const std::string & bitstring) { | ||
| BitArray<NUM_BITS,ZERO_LEFT>::operator=(const std::string & bitstring) & { |
There was a problem hiding this comment.
inadvertently leaked-in off topic diff?
| @@ -997,15 +997,15 @@ namespace emp { | |||
| /// Assignment operator from a std::bitset. | |||
| template <size_t NUM_BITS, bool ZERO_LEFT> | |||
| BitArray<NUM_BITS,ZERO_LEFT> & | |||
| BitArray<NUM_BITS,ZERO_LEFT>::operator=(const std::bitset<NUM_BITS> & bitset) { | |||
| BitArray<NUM_BITS,ZERO_LEFT>::operator=(const std::bitset<NUM_BITS> & bitset) & { | |||
There was a problem hiding this comment.
inadvertently leaked-in off topic diff?
| /// Set a range of bits to one: [start, stop) | ||
| BitVector & SetRange(size_t start, size_t stop) | ||
| { return ApplyRange([](field_t){ return FIELD_ALL; }, start, stop); } | ||
| /// Set a range of bits to value (default one): [start, stop) |
There was a problem hiding this comment.
inadvertently leaked-in off topic diff?
|
Closing, superseded by #484 |
mmore500
added a commit
that referenced
this pull request
Dec 8, 2023
Isolate docs changes from MABE changes in #480
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.