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.

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

Update code documentation to Go 1.19 documentation syntax #563

Closed
Tracked by #153
orpheuslummis opened this issue Jun 26, 2022 · 2 comments
Closed
Tracked by #153

Update code documentation to Go 1.19 documentation syntax #563

orpheuslummis opened this issue Jun 26, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@orpheuslummis
Copy link
Contributor

Part of #153

Update code documentation to new format provided by Go 1.19, with headings, lists, URL links, documentation/symbol links, and overall new syntax.

https://github.com/golang/proposal/blob/master/design/51082-godocfmt.md

@orpheuslummis orpheuslummis added the documentation Improvements or additions to documentation label Jun 26, 2022
@orpheuslummis orpheuslummis added this to the DefraDB v0.4 milestone Jun 26, 2022
@orpheuslummis orpheuslummis self-assigned this Jun 26, 2022
@orpheuslummis orpheuslummis modified the milestones: DefraDB v0.4, DefraDB v0.5 Jul 22, 2022
@orpheuslummis
Copy link
Contributor Author

Postponed to v0.6 because facing godoc-related issues related to it and is not high priority.

@fredcarle fredcarle modified the milestones: DefraDB v0.6, DefraDB v0.7 Jul 22, 2023
@fredcarle fredcarle removed this from the DefraDB v0.7 milestone Jul 31, 2023
@AndrewSisley
Copy link
Contributor

Closing, as it seems unlikely that anyone we dedicate a large chunk of time for this anytime soon and keeping it is not worth the backlog noise. It also growing out of date

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants