updated docs

This commit is contained in:
Ashley Bao 2023-01-26 11:53:49 -05:00
parent 71c8e51dea
commit f47d05e279
57 changed files with 74 additions and 62 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -174,6 +174,7 @@ then you should call `-main` without arguments, as `(-main).
- [Adding genetic operators](Adding_Genetic_Operators.md) - [Adding genetic operators](Adding_Genetic_Operators.md)
- [Adding selection methods](Adding_Selection_Method.md) - [Adding selection methods](Adding_Selection_Method.md)
- [Adding a new problem](Adding_Problem.md) - [Adding a new problem](Adding_Problem.md)
- [Generating Documentation](Generating_Documentation.md)
## Contributing ## Contributing
@ -181,6 +182,9 @@ You can report a bug on the [GitHub issues page](https://github.com/lspector/pro
The best way to contribute to Propeller is to fork the [main GitHub repository](https://github.com/lspector/propeller) and submit a pull request. The best way to contribute to Propeller is to fork the [main GitHub repository](https://github.com/lspector/propeller) and submit a pull request.
Propeller provides a way to automatically [generate documentation](Generating_Documentation.md) for any contributions
you might make.
## License ## License
**Eclipse Public License 2.0** **Eclipse Public License 2.0**

View File

@ -25,7 +25,7 @@ you can fetch datasets using `psb2.core/fetch-examples`.
``` ```
2. Define the possible Push instructions to be used to create plushys. It should be a non-lazy list of 2. Define the possible Push instructions to be used to create plushys. It should be a non-lazy list of
instructions from `push/instructions` instructions from `push/instructions`, input instructions, close, and constants (including functions that produce constants).
3. Define an error function that will evaluate plushys and add `:behaviors parsed-outputs`, 3. Define an error function that will evaluate plushys and add `:behaviors parsed-outputs`,
`:errors`, and `:total-error` to the individual `:errors`, and `:total-error` to the individual
4. Define the function `-main` with a map of default arguments. 4. Define the function `-main` with a map of default arguments.

View File

@ -1,6 +1,6 @@
# Generating Documentation for Propeller # Generating Documentation for Propeller
To generate documentation with [codox](https://github.com/weavejester/codox), run `GenerateDocs.sh` in the command line. To generate documentation with [codox](https://github.com/weavejester/codox), run `scripts/GenerateDocs.sh`in the command line.
This will run "lein codox" on the command line to generate first batch of HTMl files. This will run "lein codox" on the command line to generate first batch of HTMl files.
Then, it runs FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file. Then, it runs FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file.
Then, it runs HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and Then, it runs HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and

View File

@ -1,9 +1,10 @@
(ns propeller.problems.PSB2.shopping-list (ns propeller.problems.PSB2.shopping-list
"DICE GAME from PSB2 "SHOPPING LIST from PSB2
Peter has an n sided die and Colin has an m Given a vector of floats representing
sided die. If they both roll their dice at the same time, return the prices of various shopping goods and another vector of
the probability that Peter rolls strictly higher than Colin. floats representing the percent discount of each of those
goods, return the total price of the shopping trip after applying the discount to each item.
Source: https://arxiv.org/pdf/2106.06086.pdf" Source: https://arxiv.org/pdf/2106.06086.pdf"
{:doc/format :markdown} {:doc/format :markdown}