docs: Add comprehensive documentation to internal implementation classes #1636
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Colhodm
commented
Feb 23, 2025
Colhodm
commented
- Add JavaDoc documentation explaining design decisions
- Document edge cases and performance implications
- Create architecture diagram showing relationships
- Create commented versions of files
- Add JavaDoc documentation explaining design decisions - Document edge cases and performance implications - Create architecture diagram showing relationships - Create commented versions of files Co-Authored-By: Arjun Mishra <arjun@cognition.ai>
|
Hi @Colhodm many thanks for the PR. We don't add javadoc to the implmentations of interfaces. For that reason I'm closing this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.