Fix documentation rendering #965
Conversation
|
Size Change: +74.8 kB (+0.61%) Total Size: 12.3 MB
|
|
Yo this is absolutely Herculean, you freakin' rock |
Since the comments clearly say "don't make this class yourself," it might make sense to mark them as `@private` so they don't show up in the documentation. The doc pages for those classes can still be visited, but they don't show up in the sidebar to the left, unless you specifically navigate to one of them. (Or, if you click a link for what the return type on the `Horizon.Server.effects()` method, for example
I don't _think_ they're accessible by SDK users, so I think it makes sense to not render them in the docs?
because more type definitions are more better, right?
…ocumentation-rendering
this commit also exports the `Configuration` interface
|
@Shaptic I think this is ready to go! Thanks for checking it out! |
…ocumentation-rendering
| * @property {string} [authToken] Allow set custom header `X-Auth-Token`, default: `undefined`. | ||
| */ | ||
|
|
||
| export namespace HorizonServer { |
There was a problem hiding this comment.
This has no tangible side-effects to downstream users because of the aliasing in index.ts, right?
There was a problem hiding this comment.
Yes, in my local testing, it behaves like normal.
- I tested the
/liboutput by usingnodein my terminal window, and interacting there. - I tested the
/distoutput by creating a dummy html page that added the/dist/stellar-sdk.jsfile in a<script>tag and interacting withStellarSdkin the browser console.
Those may not be the best ways to test, though, so if there's another method, I'm certainly down for that.
|
@Shaptic when I run If I run that replacing |
|
I ended up just committing all those changes in a single commit, so it'll be easy enough to revert if you want to: 841f7c9 Edit: I did a bit of digging, and it looks like commit 21bd09 from #860 is when the prettier directory changed from Another Edit: I built and previewed the docs after the prettier changes, and everything looks the same as before. Still good to go, I think |
I'm trying to get all the JSDoc rendering to work now that the SDK has had a chance to settle a bit with its inclusion of the Soroban functionality.
Refs: #920