square / square/connect-api-specification

C# templates cause duplicate information to be displayed.

Open
#87 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
76
Forks
36
Avg merge
3h 14m
Merged PRs (30d)
1

Description

image

Affecting model markdown docs like: https://github.com/square/connect-csharp-sdk/blob/master/docs/V1EmployeesApi.md#createemployee

This is likely an issue with a repeated print from the template, or possibly printing two different variables from the template that we have assigned to be the same thing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked docs/V1EmployeesApi.md#createemployee output and trace the C# template that renders the affected model markdown. Check whether the duplicate comes from a repeated print or from two equivalent template variables. Done means the generated documentation no longer displays the same information twice.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
documentation, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.