microsoft / microsoft/teams.ts
Unclear usage of overrideSignInActivity
- Dominant language
- TypeScript
- Stars
- 107
- Forks
- 39
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 74
Description
overrideSignInActivity?: (
tokenExchangeResource?: TokenExchangeResource,
tokenPostResource?: TokenPostResource,
signInLink?: string
) => ActivityLike; in https://github.com/microsoft/teams.ts/blob/fb646c421851bcf59c7090f48ed3f0b89e621bf4/packages/apps/src/contexts/activity.ts#L114 will lead user to believe that they cannot customize tokenExchangeResource, tokenPostResource and signInLink but can only process these values after receiving it.
Would be better if we could make it clear or adding some docs around it.
Contributor guide
Research direction
Start at packages/apps/src/contexts/activity.ts around line 114 and read the overrideSignInActivity type and its surrounding context. Clarify in the API text or nearby documentation whether tokenExchangeResource, tokenPostResource, and signInLink can be customized, and ensure the resulting usage guidance matches the declared behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100