mattermost / mattermost/react-native-emm
`getManagedConfig` documentation outdated
Open
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 18
- Forks
- 7
- Avg merge
- 1h 52m
- Merged PRs (30d)
- 1
Description
The getManagedConfig function in the README is documented as returning a Promise (async function), but the actual implementation in recent versions is synchronous.
It would be great to resolve this mismatch between documentation and implementation.
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
Read the README entry for getManagedConfig and compare it with the implementation in src/emm.ts at the linked commit. Update the documentation to describe its synchronous return behavior, then check the README for consistent wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native, typescript
- Domain
- documentation, mobile
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100