Skip to content
This repository has been archived by the owner on Jan 25, 2025. It is now read-only.

144: Add example of using team.members #146

Merged
merged 1 commit into from
Apr 12, 2024
Merged

Conversation

JensAstrup
Copy link
Owner

No description provided.

@JensAstrup JensAstrup linked an issue Apr 12, 2024 that may be closed by this pull request
@JensAstrup JensAstrup merged commit a3b0516 into develop Apr 12, 2024
2 checks passed
@JensAstrup JensAstrup deleted the 144-update-readme branch April 12, 2024 19:33
Copy link

The changes introduced in this Pull Request primarily focus on enhancing documentation and code examples to provide more clarity on how to use the Shortcut API Client. Here are some key observations:

  1. Good addition to the README with the examples of navigating through the relationships between stories, epics, owners, and teams to access team members efficiently. This helps in making it clear how the library can be used to handle complex data relationships easily. The addition of const members: Member[] = await team.members is an intuitive example that demonstrates the utility of the library for end-users.

  2. There is an unnecessary extra line added at the end of the code block before the "## Installation" section. This doesn't follow common Markdown or documentation practices and could lead to visual inconsistency. Consider removing the extra line breaks to maintain a clean and professional look in the documentation.

Overall, the modified documentation does a great job of illustrating the library's capabilities through practical examples. Removing the extra line breaks would refine the visual presentation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README
1 participant