doc: Add link to contributor's guide for new functions within the src #7240
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
alamb
approved these changes
Aug 9, 2023
| @@ -25,6 +25,8 @@ use std::{fmt, str::FromStr}; | |||
| use strum_macros::EnumIter; | |||
|
|
|||
| /// Enum of all built-in aggregate functions | |||
| // Contributor's guide for adding new aggregate functions | |||
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.
Which issue does this PR close?
NA
Rationale for this change
I've noticed it's easy to forget to add SQL reference documentation when adding new functions.
Automate this task seems hard to do and maintain, so I think at least we can remind contributors to do so somewhere in the src, function ENUM declaration should be a good place for such README
What changes are included in this PR?
sqllogictestand SQL reference docAre these changes tested?
The doc has been built locally and all links have been tested
Are there any user-facing changes?
No