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

multi: Document exported names. #1497

Merged
merged 5 commits into from Sep 6, 2021
Merged

multi: Document exported names. #1497

merged 5 commits into from Sep 6, 2021

Conversation

amass01
Copy link
Member

@amass01 amass01 commented Sep 4, 2021 •
edited

This adds documentation for undocumented exported names in multiple
parts of the codebase:

  • www: comments API.
  • www: records API.
  • www: tikcetvote API.
  • d: v2 API.

@amass01 amass01 changed the title www: Document exported names in comments API. [wip] multi: Document exported names. Sep 5, 2021
@amass01 amass01 marked this pull request as draft September 5, 2021 22:45
@amass01 amass01 changed the title [wip] multi: Document exported names. multi: Document exported names. Sep 6, 2021
@amass01 amass01 marked this pull request as ready for review September 6, 2021 14:33
lukebp
lukebp requested changes Sep 6, 2021
View reviewed changes
politeiad/api/v2/v2.go Outdated Show resolved Hide resolved
politeiad/api/v2/v2.go Outdated Show resolved Hide resolved
lukebp
lukebp approved these changes Sep 6, 2021
View reviewed changes
Copy link
Member

@lukebp lukebp left a comment

Choose a reason for hiding this comment

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

Nice job. Improving documentation is always welcome.

@lukebp lukebp merged commit 9b30978 into decred:master Sep 6, 2021
@amass01 amass01 deleted the docplugins branch September 6, 2021 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukebp lukebp lukebp 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.

None yet
2 participants
@amass01 @lukebp