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

Use "experimental" instead of "Experimental" #4488

Closed
pellared opened this issue May 15, 2024 · 4 comments
Closed

Use "experimental" instead of "Experimental" #4488

pellared opened this issue May 15, 2024 · 4 comments

Comments

@pellared
Copy link
Member

Notice that Experimental (starting with capital letter) is used in Specification and Semantic Conventions. Can we have a separate issue so that we apply the trach and change in all possible places?

Originally posted by @pellared in #4463 (comment)

@pellared
Copy link
Member Author

@chalin, @svrnm: Please feel free to edit my description.

@svrnm
Copy link
Member

svrnm commented May 15, 2024

Ah, ok, now I understand. Thinking out loud, how about the following:

  • We use Experimental (with a link to the explanation in the spec) whenever it's spec/semconv-Experimental
  • We use experimental otherwise

This way we can make it clear to readers that the one thing is "official". Of course that linking may not work in a title.

@chalin
Copy link
Contributor

chalin commented May 15, 2024

Thanks for creating this issue to track the discussion. My main objective in the original edit was to ensure that "Collector" was capitalized. Otherwise, we (should) use sentence case in headings (per our language guide(ance) -- though we haven't started applying that consistently at all.

I like what @svrnm proposes.

All-in-all, this isn't a super important; and sorry for having brought it up. As I mentioned, it was really the capitalization of Collector I was primarily targeting.

@svrnm
Copy link
Member

svrnm commented May 16, 2024

the way it is solved now and especially moving the "experimental" out of the title is a good solution! I think we can close this one

@svrnm svrnm closed this as completed May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants