ChilliCream / ChilliCream/graphql-platform
Add support for <inheritdoc> cref
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 5.8k
- Forks
- 810
- Avg merge
- 15h 39m
- Merged PRs (30d)
- 98
Description
Product
Hot Chocolate
Version
14.0.0
Link to minimal reproduction
https://github.com/kuglitsd/HotChocolateInheritdoc
Steps to reproduce
Run the project.
Inheritdoc only seems to be working for Implementations of Interface Methods. Everything else does NOT seem to work
What is expected?
The tag should correctly inherit and display the documentation comments from the specified members, classes, or interfaces in the schema
What is actually happening?
Only the comment inherited from the IQuery interface implementation seems to work.
Relevant log output
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked minimal reproduction and run the project to compare interface implementation inheritance with the other cref cases described in the issue. Trace the Hot Chocolate handling of XML documentation and schema display, then verify that comments from specified members, classes, and interfaces are inherited as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100