Skip to content

Commit

Permalink
update dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ericphanson
ericphanson committed May 13, 2024
1 parent 5364504 commit 091f006
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/developer/contributing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Convex.jl. Let's say you're adding the new function $f$.
- Ensure the atom is a mutable struct, so that `objectid` can be called.
- Add as a comment a description of what the atom does and its
parameters.
- Ensure `evaluate` is only called during the definition of `evaluate` itself, from `conic_form!`, or
on constants or matrices. Specifically, `evaluate` must not be called on a potentially `fix!`'d variable
when the expression tree is being built (e.g. when constructing an atom or reformulating),

Check failure on line 45 in docs/src/developer/contributing.md

View workflow job for this annotation

GitHub Actions / build 

[vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/src/developer/contributing.md", "range": {"start": {"line": 45, "column": 47}}}, "severity": "ERROR"}
since then any changes to the variable's value (or it being `free!`'d) will not be recognized.
See [#653](https://github.com/jump-dev/Convex.jl/issues/653) and [#585](https://github.com/jump-dev/Convex.jl/issues/585)
for previous bugs caused by misuse here.
- The most mathematically interesting part is the `new_conic_form!`
function. Following the example in the nuclear norm atom, you'll
see that you can just construct the problem whose optimal value is
Expand Down

0 comments on commit 091f006

Please sign in to comment.