Skip to content

Commit

Permalink
Merge pull request #514 from devosoft/refresh-docs
Browse files Browse the repository at this point in the history
Refresh docs
  • Loading branch information
mmore500 authored Apr 18, 2024
2 parents e7ff3cd + 91b820d commit 3c901ac
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions doc/QuickStartGuides/1-HelloWorld.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ get your working environment all set.
```shell
git clone https://github.com/devosoft/Empirical
cd Empirical/examples/ProjectTemplate
git submodule update --init --depth 1 --recursive
```

Let's take a look at what we want to compile.
Expand Down
6 changes: 3 additions & 3 deletions doc/QuickStartGuides/2-BaseTools.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ standard library, but provide extra protection against common memory use
errors and additional information to the developer. These protections
can be turned off by comiling with -DNDEBUG.

## base/assert.h
## base/assert.hpp

This file adds an `emp_assert` macro that can handle all of the same
functionality as the standard library assert, but with additional
Expand Down Expand Up @@ -35,7 +35,7 @@ compiled using the `NDEBUG` option (for most compilers, this
deactivation is accomplished by using the `-DNDEBUG` flag at compile
time.)

## base/array.h and base/vector.h
## base/array.hpp and base/vector.hpp

These files setup the `emp::array<...>` and `emp::vector<...>` template
objects, which behave almost identically to `std::array<...>` and
Expand All @@ -44,7 +44,7 @@ bounds checking when they are indexed into or specific size matters. As
with asserts, these additional bounds checks are removed when compiled
with the `NDEBUG` option.

## base/Ptr.h
## base/Ptr.hpp

The `emp::Ptr<...>` template provides an alternate method of building
pointers, but with the ability to turn on additional debugging
Expand Down
2 changes: 1 addition & 1 deletion doc/library/web/d3/d3-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Using Empirica's D3.js Wrapper
# Using Empirical's D3.js Wrapper

If you're writing scientific code that runs on the web, you'll
probably want to visualize the results (either as your program runs or
Expand Down

0 comments on commit 3c901ac

Please sign in to comment.