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.

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

268: Add MemberProfile to docs #275

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

JensAstrup
Copy link
Owner

No description provided.

@JensAstrup JensAstrup linked an issue Jun 4, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Jun 4, 2024

The changes in your pull request seem to revolve around the expansion of exported entities in your TypeScript project and an update to the MemberProfile contract. There are a few things to note:

  1. Addition of MemberProfile in index.ts:
    The MemberProfile import and export have been correctly added to your index.ts file. This is a good practice as it helps in maintaining a clear and accessible export structure from a module.

  2. Double export {} block in index.ts:

    • You've split the exports into two blocks. While this is not inherently incorrect, it could lead to confusion or inconsistency in the structure of your exports. It's generally more concise to group all exports into a single export {} block unless there is a specific reason to separate them, like conditional exports based on environmental conditions.
    • Suggestion: Consider merging the exports into a single export {} block for clarity and consistency.
  3. Syntax consistency in member-profile.ts:

    • You've updated the MemberProfile interface to use commas instead of semicolons for property separation. Both are valid in TypeScript interfaces, but it's best to keep consistency across your project. If the rest of your project uses commas, this change is good; otherwise, align it with the project's standard.
    • The removal of trailing commas for interface properties is a style choice. Be sure it aligns with your project's style guide or linter rules.
  4. Multiple Export Statements for MemberProfile:

    • You have both a named export and a default export for MemberProfile. This practice might be redundant and could lead to confusion when importing MemberProfile elsewhere in the project. Typically, it's best to choose either named exports or default exports for a module, especially when there is only one entity to export.
    • If MemberProfile is meant to be the primary or only export from its module, using a default export makes sense. However, if you're exporting multiple entities from this module, sticking to named exports could improve consistency and import predictability.

Overall, your changes are straightforward and appear to serve the purpose of extending the functionality and exportability of your codebase. Just ensure that your decision on exports and syntax style aligns with the overall project standards and best practices.

Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.97%. Comparing base (3a12e0e) to head (11f0555).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #275      +/-   ##
===========================================
- Coverage    92.08%   91.97%   -0.12%     
===========================================
  Files           50       50              
  Lines         2489     2491       +2     
  Branches       311      165     -146     
===========================================
- Hits          2292     2291       -1     
- Misses         196      200       +4     
+ Partials         1        0       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JensAstrup JensAstrup merged commit c3d2756 into develop Jun 4, 2024
10 of 11 checks passed
@JensAstrup JensAstrup deleted the 268-add-memberprofile-to-documentation branch June 4, 2024 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add MemberProfile to documentation
1 participant