Update reference API

[rmarkello]

Closes #??

Proposed Changes

• Adds info to reference API

What other functions / classes should be added to the API? Happy to add whatever but I don't think everything needs to be on it.

[codecov]

Codecov Report

Merging #231 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #231   +/-   ##
=======================================
  Coverage   93.66%   93.66%           
=======================================
  Files           8        8           
  Lines         679      679           
=======================================
  Hits          636      636           
  Misses         43       43           

[smoia]

I didn't try to build it locally yet, but I think it's ok!

I wonder if it makes sense to add a heuristic file as well?

What do you think?

[rmarkello]

Like, a template heuristic file? Or the function for processing the heuristic file (i.e., use_heur() or whatever it's called)?

In my mind the API should just be documenting functions in the codebase, so if you were suggesting the former I'd err on the side of no. But I can add the latter, if you'd like?

[smoia]

Mmm, yeah, you're right. I don't think it's necessary to document the latter though - I think there's everything we need!

[smoia]

Looks good to me, thank you for the PR!
If you're happy with it, you can merge it!