Skip to content

(Update wrap) add functionality to pull docs from parent classes#2118

Merged
dellaert merged 5 commits intodevelopfrom
docparse-inheritor
May 24, 2025
Merged

(Update wrap) add functionality to pull docs from parent classes#2118
dellaert merged 5 commits intodevelopfrom
docparse-inheritor

Conversation

@p-zach
Copy link
Copy Markdown
Member

@p-zach p-zach commented Apr 29, 2025

Update wrap to pull in this functionality. Also add a note to DEVELOP.md about docs inheritance and modify geometry.i so that logmaps have docs (expmap parameters were already correct).

>>> help(gtsam.Pose2.logmap)
Help on instancemethod in module gtsam.gtsam:

logmap(...)
    logmap(*args, **kwargs)
    Overloaded function.

    1. logmap(self: gtsam.gtsam.Pose2, p: gtsam.gtsam.Pose2) -> numpy.ndarray[numpy.float64[3, 1]]

    Applies logarithmic map to group element that takes *this to g.

    2. logmap(self: gtsam.gtsam.Pose2, p: gtsam.gtsam.Pose2, H1: numpy.ndarray[numpy.float64[m, n], flags.writeable, flags.f_contiguous], H2: numpy.ndarray[numpy.float64[m, n], flags.writeable, flags.f_contiguous]) -> numpy.ndarray[numpy.float64[3, 1]]

    logmap with optional derivatives

p-zach added 4 commits April 28, 2025 22:10
66087700e Merge pull request #176 from p-zach/add-docs-inherit
c28ce13c8 Add superclass search if subclass has no docs
d0f775b50 Merge pull request #174 from yambati03/fix-xml-parser
7741153ee Fix some errors in the xml_parser script

git-subtree-dir: wrap
git-subtree-split: 66087700e50917f96a7ba89a02c45edb7b7c04b3
@p-zach p-zach requested a review from dellaert April 29, 2025 02:36
@p-zach
Copy link
Copy Markdown
Member Author

p-zach commented Apr 29, 2025

Uh, not sure why the Ubuntu test is failing. @yambati03 ? I can't imagine this is an issue with my changes, lol.

@dellaert
Copy link
Copy Markdown
Member

dellaert commented May 9, 2025

@p-zach @yambati03 what's needed to merge?

@p-zach
Copy link
Copy Markdown
Member Author

p-zach commented May 23, 2025

Seems like the issue worked itself out. Added a commit to fix the tiny conflict in geometry.i. Good to merge.

Copy link
Copy Markdown
Member

@dellaert dellaert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@dellaert dellaert merged commit c290acc into develop May 24, 2025
36 checks passed
@dellaert dellaert deleted the docparse-inheritor branch May 24, 2025 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants