Update README.md

This commit is contained in:
Luke Weiler
2022-12-19 02:55:37 -05:00
committed by GitHub
parent 09a82d242a
commit a12bd5cd0f

View File

@@ -56,7 +56,7 @@ This creates the pdf `ws.pdf` in your current directory
--> -->
Problem/solution pairs are generated with either: Problem/solution pairs are generated with either:
* `mathgen.<generator_name>()` - generates a problem, solution set from the given generator name. * `mathgen.<generator_name>()` - generates a problem, solution set from the given generator name.
* `mathgen.genById(id)` - generates a problem, solution set with generator id `id` in the format `[problem, solution]` * `mathgen.genById(id)` - generates a problem, solution set with generator id provided by the `id` parameter
<!-- <!--
#### `format` kwarg #### `format` kwarg
@@ -64,7 +64,10 @@ Problem/solution pairs are generated with either:
* Pass `format=raw` to return just the raw data for each generator. An array of each variable necessary to the generator is returned. * Pass `format=raw` to return just the raw data for each generator. An array of each variable necessary to the generator is returned.
* If you don't pass a value to the format kwarg, the generator will return a problem and answer in asciimath format. * If you don't pass a value to the format kwarg, the generator will return a problem and answer in asciimath format.
--> -->
You can also use `getGenList()` to return a list of all generators in the repository in the format `[id, title, self, funcname, subjectname]` You can also use `getGenList()` to return a list of all generators included in the library in the format:
```
[id, title, self, funcname, subjectname]
```
## List of Generators ## List of Generators