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

Fix formatting and cross-references in WebAuth jsdocs #884

Merged
merged 1 commit into from
Nov 27, 2023
Merged

Fix formatting and cross-references in WebAuth jsdocs #884

merged 1 commit into from
Nov 27, 2023

Conversation

Shaptic
Copy link
Contributor

@Shaptic Shaptic commented Nov 27, 2023

Specifically, this does a few things:

  • line wrapping at 80 cols and indentation for readability
  • new {@link ...}s to add cross references
  • shortening the SEP-10 protocol link
  • fixing the examples to use the correct imports & module names (Utils/Sep10 -> WebAuth)

@Shaptic Shaptic self-assigned this Nov 27, 2023
JakeUrban
JakeUrban approved these changes Nov 27, 2023
View reviewed changes
Copy link
Contributor

@JakeUrban JakeUrban left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions GitHub Actions
Copy link

Size Change: +1.18 kB (0%)

Total Size: 12.1 MB

Filename Size Change
dist/stellar-sdk.js 6.96 MB +878 B (0%)
dist/stellar-sdk.min.js 5.1 MB +299 B (0%)

compressed-size-action

@Shaptic Shaptic merged commit f2366e3 into master Nov 27, 2023
8 checks passed
@Shaptic Shaptic deleted the fixup-sep10-jsdoc branch November 27, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JakeUrban JakeUrban JakeUrban approved these changes

@sreuland sreuland Awaiting requested review from sreuland

@stellarsaur stellarsaur Awaiting requested review from stellarsaur

Assignees

@Shaptic Shaptic

Labels
None yet
Projects
Platform Scrum
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Shaptic @JakeUrban