Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[sitecore-jss] Audit API reference description for accuracy and completeness #1031

Merged
merged 5 commits into from
May 31, 2022
Merged

[sitecore-jss] Audit API reference description for accuracy and completeness #1031

merged 5 commits into from
May 31, 2022

Conversation

addy-pathania
Copy link
Contributor

@addy-pathania addy-pathania commented May 19, 2022 •
edited by illiakovalenko
Loading

We would like the API described by our exports and Typedoc comments to be accurate and complete.

The functions that we export to our npm package should document the following:

Purpose of the function
Description of parameters via @param
Description of return possibilities via @returns
A list of possible exceptions via @throws

Also added more unit tests wherever possible to improve test coverage.

Description / Motivation

Testing Details

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@addy-pathania addy-pathania requested a review from a team May 19, 2022 18:04
illiakovalenko
illiakovalenko approved these changes May 31, 2022
View reviewed changes
packages/sitecore-jss/src/debug.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/graphql/app-root-query.ts Show resolved Hide resolved
packages/sitecore-jss/src/i18n/rest-dictionary-service.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/i18n/rest-dictionary-service.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/i18n/rest-dictionary-service.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/utils/resolve-url.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/layout/utils.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/data-fetcher.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/tracking/trackingApi.ts Outdated Show resolved Hide resolved
packages/sitecore-jss/src/utils/resolve-url.ts Show resolved Hide resolved
illiakovalenko
illiakovalenko requested changes May 31, 2022
View reviewed changes
Copy link
Contributor

@illiakovalenko illiakovalenko left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See some comments above and link your PR to the PBI

illiakovalenko
illiakovalenko approved these changes May 31, 2022
View reviewed changes
Copy link
Contributor

@illiakovalenko illiakovalenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice 👍

@illiakovalenko illiakovalenko merged commit 4e85a70 into dev May 31, 2022
@illiakovalenko illiakovalenko deleted the feature/475877-audit-api-reference branch May 31, 2022 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@illiakovalenko illiakovalenko illiakovalenko approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@addy-pathania @illiakovalenko