Skip to content

Complete and Require Javadocs #1910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

samfreund
Copy link
Member

Description

Meta

Merge checklist:

  • Pull Request title is short, imperative summary of proposed changes
  • The description documents the what and why
  • If this PR changes behavior or adds a feature, user documentation is updated
  • If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly
  • If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1
  • If this PR touches pipeline settings or anything related to data exchange, the frontend typing is updated
  • If this PR addresses a bug, a regression test for it is added

@mcm001
Copy link
Contributor

mcm001 commented Apr 16, 2025

A lot of these docs are just re-stating the function name. Like of course the constructor makes a new X

Try to see how the javadocs can explain more than just surface level things.

@Gold856 Gold856 added the documentation Anything relating to https://docs.photonvision.org label Jul 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything relating to https://docs.photonvision.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants