Something wrong with 3rd part document generate
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.5k
- Forks
- 124
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 9
Description
Actual behavior
When generate document, the help link always say Read more on learn.microsoft.com. And the read more para seems always generated on parts which has para tags, which will duplicate when both generated on summary and remarks.
And the help link will add hash which work in learn.microsoft.com but not work in other links.
Expected behavior
Say Read more on learn.microsoft.com only when the help link is learn.microsoft.com. When the link is 3rd part, say Read more on website or Read more on ${hostname}. And not generate 3rd part param and field help link.
Repro steps
Generate a 3rd part document.
Context
- CsWin32 version: 0.3.269
- Target Framework: net4.8.1
LangVersion(if explicitly set by project): latest
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
No source file, test, or entry point is named. Reproduce the issue by generating a third-party document with CsWin32 0.3.269 and inspect the generated summary and remarks sections, including help links with and without a learn.microsoft.com hostname. Done means third-party links use suitable wording without unsupported hashes, and parameter or field help is not duplicated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100