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

Generate a doc string comment for the record #42

Closed
Tracked by #158
pleshakov opened this issue Mar 7, 2024 · 2 comments · Fixed by #187
Closed
Tracked by #158

Generate a doc string comment for the record #42

pleshakov opened this issue Mar 7, 2024 · 2 comments · Fixed by #187
Assignees
Labels
bug An issue reporting a potential bug refined Issues that are ready to be prioritized
Milestone

Comments

@pleshakov
Copy link
Contributor

The F5 telemetry service requires a doc string comment for the record:

Wrong:

@namespace("gateway.nginx.org") protocol NGFProductTelemetry {
	@df_datatype("ngf-product-telemetry") record Data {
		/** The field that identifies what type of data this is. */
		string dataType;
                . . . 

Correct:

@namespace("gateway.nginx.org") protocol NGFProductTelemetry {
	/** Data is the product telemetry data of NGINX Gateway Fabric. */
	@df_datatype("ngf-product-telemetry") record Data {
		/** The field that identifies what type of data this is. */
		string dataType;
                . . . 
@pleshakov pleshakov added the bug An issue reporting a potential bug label Mar 7, 2024
@shaun-nx
Copy link

@pleshakov I think it might be easier to make this docs string generic.

Some like this:

/** Telemetry data for this product. */

What do you think?

@pleshakov
Copy link
Contributor Author

@shaun-nx looks reasonable! as long as it is accepted.

@lucacome lucacome mentioned this issue Jul 16, 2024
@mpstefan mpstefan added the refined Issues that are ready to be prioritized label Jul 17, 2024
@lucacome lucacome self-assigned this Aug 12, 2024
@lucacome lucacome added this to the v0.1.1 milestone Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An issue reporting a potential bug refined Issues that are ready to be prioritized
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants