Skip to content

Commit

Permalink
[SymForce] Update doc-string to reflect signature
Browse files Browse the repository at this point in the history
The doc-string said this function returns the total residual dimension,
but it does not. So I removed that sentence.

Also, removed the second space between two other sentences because it's
my understanding that only old people do that.

Topic: doc_string_should_be_correct
GitOrigin-RevId: b0fda17252cd5b7bbab2ce0792c41c9a4214967e
  • Loading branch information
bradley-solliday-skydio authored and aaron-skydio committed Mar 31, 2023
1 parent 72c45e4 commit 8fd8c1c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions symforce/opt/linearizer.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ class Linearizer {
const std::vector<Key>& key_order = {}, bool include_jacobians = false);

/**
* Update linearization at a new evaluation point. Returns the total residual dimension M.
* This is more efficient than reconstructing this object repeatedly. On the first call, it will
* Update linearization at a new evaluation point.
* This is more efficient than reconstructing this object repeatedly. On the first call, it will
* allocate memory and perform analysis needed for efficient repeated relinearization.
*
* TODO(aaron): This should be const except that it can initialize the object
Expand Down

0 comments on commit 8fd8c1c

Please sign in to comment.