Skip to content

mutlibody_plant: Convert class overview to javadoc - #14499

Merged
rpoyner-tri merged 1 commit into
RobotLocomotion:masterfrom
EricCousineau-TRI:issue-14498
Jan 6, 2021
Merged

mutlibody_plant: Convert class overview to javadoc#14499
rpoyner-tri merged 1 commit into
RobotLocomotion:masterfrom
EricCousineau-TRI:issue-14498

Conversation

@EricCousineau-TRI

@EricCousineau-TRI EricCousineau-TRI commented Jan 6, 2021

Copy link
Copy Markdown
Contributor

Resolves #14498

Using latest commit (0336878) from #13461 (review), using this command:

bazel-bin/tools/lint/cpp_docstring_lint multibody/plant/multibody_plant.h

I cherry-picked the diff for class overview, then left everything else the same.


This change is Reviewable

@EricCousineau-TRI EricCousineau-TRI left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

+@joemasterjohn for a quick feature review, please?
+@rpoyner-tri for a quick platform review, please?

I dunno why git diff isn't working that well, but TBH meh. I just want to resolve this for #12590

Reviewable status: LGTM missing from assignees rpoyner-tri(platform),joemasterjohn (waiting on @joemasterjohn and @rpoyner-tri)

@joemasterjohn joemasterjohn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: LGTM missing from assignee rpoyner-tri(platform) (waiting on @joemasterjohn and @rpoyner-tri)

@EricCousineau-TRI

Copy link
Copy Markdown
Contributor Author

MutlibodyPlant pydrake docs before: https://drake.mit.edu/pydrake/pydrake.multibody.plant.html#pydrake.multibody.plant.MultibodyPlant_

image

After:

image

Not perfect, but a step in the right direction.

@rpoyner-tri rpoyner-tri left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r1.
Reviewable status: LGTM missing from assignee rpoyner-tri(platform) (waiting on @joemasterjohn)

@rpoyner-tri rpoyner-tri left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ugh, diff fail, but :lgtm:

Reviewable status: :shipit: complete! all discussions resolved, LGTM from assignees rpoyner-tri(platform),joemasterjohn (waiting on @joemasterjohn)

@rpoyner-tri
rpoyner-tri merged commit 17289be into RobotLocomotion:master Jan 6, 2021
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.

plant: Weird mix of documentation messes up mkdoc parsing

3 participants