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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[馃搼 Docs]: expand documentation for the new traits merge mechanism introduced in v3 #1879

Closed
1 task done
smoya opened this issue Jun 30, 2023 · 2 comments
Closed
1 task done

Comments

@smoya
Copy link
Member

smoya commented Jun 30, 2023

What Dev Docs changes are you proposing?

@Fannon made a good point regarding the lack of expanded documentation regarding how the new traits merge mechanism works in v3.

Literally, the following is their comment:

Imho, it would be very nice to point to a reference implementation or code snippet how this is to be implemented correctly. As a Dev, I would feel more confident looking at a code example to check my understanding. I like the example, but a simple example cannot cover all the interesting corner cases :)

Originally posted by @Fannon in asyncapi/spec#907 (comment)

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Fannon
Copy link

Fannon commented Jun 30, 2023

Thanks for keeping track of this :)

I wonder if you could just point to an implementation, e.g. in an AsyncAPI documentation generator / renderer / playground. If you decouple the merge logic to its own function, it's easy to read and to write tests against it. (Maybe also link to tests? Some specs even provide test-suites specifically to test whether you implemented something correctly).

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 馃槾

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience 鉂わ笍

@github-actions github-actions bot added the stale label Oct 29, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants