Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add documentation comments for several types #3169

Merged
merged 1 commit into from
Mar 2, 2024
Merged

Add documentation comments for several types #3169

merged 1 commit into from
Mar 2, 2024

Conversation

emesterhazy
Copy link
Collaborator

These comments are intended to make it easier for new developers to get up to speed with the project. This is just a starting point... there are other types and functions that could benefit from documentation.

martinvonz
martinvonz approved these changes Feb 29, 2024
View reviewed changes
Copy link
Owner

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

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

Thanks!

I don't think it applies to any of these files, but if you manage to document all public symbols in a file, please remove #![allow(missing_docs)] to prevent regressions.

lib/src/backend.rs Outdated Show resolved Hide resolved
lib/src/object_id.rs Outdated Show resolved Hide resolved
lib/src/object_id.rs Outdated Show resolved Hide resolved
lib/src/object_id.rs Outdated Show resolved Hide resolved
yuja
yuja approved these changes Mar 1, 2024
View reviewed changes
lib/src/object_id.rs Outdated Show resolved Hide resolved
@emesterhazy emesterhazy force-pushed the push-quswyttvwntl branch 2 times, most recently from a52bc5d to c47f1f7 Compare March 1, 2024 17:54
@emesterhazy
Add documentation comments for several types
daa9930 
These comments are intended to make it easier for new developers to get up to
speed with the project. This is just a starting point... there are other types
and functions that could benefit from documentation.
@emesterhazy emesterhazy merged commit a335321 into main Mar 2, 2024
16 checks passed
@emesterhazy emesterhazy deleted the push-quswyttvwntl branch March 2, 2024 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yuja yuja yuja approved these changes

@martinvonz martinvonz martinvonz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@emesterhazy @yuja @martinvonz