Fix documentation rendering #965
Conversation
|
Size Change: +72.2 kB (+0.6%) Total Size: 12.1 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?
There was a weird `_default` global that came up from this. Not sure why, but this seems to have done the trick without anything weird going on after.
it doesn't look like it's accessible anywhere for an SDK user, so let's hide it from the generated docs
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎ To accept the risk, merge this PR and you will not be notified again.
Next stepsWhat is network access?This module accesses the network. Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use. What is filesystem access?Accesses the file system, and could potentially read sensitive data. If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead. Take a deeper look at the dependencyTake a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev. Remove the packageIf you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency. Mark a package as acceptable riskTo ignore an alert, reply with a comment starting with
|
| @@ -2,8 +2,9 @@ import { xdr, cereal } from "@stellar/stellar-base"; | |||
| import type { AssembledTransaction } from "./assembled_transaction"; | |||
|
|
|||
| /** | |||
| * The default timeout for waiting for a transaction to be included in a block. | |||
| * The default timebounds, in seconds, during which a transaction will be valid. | |||
There was a problem hiding this comment.
cc @chadoh I forget, is this from the creation of the transaction, assembly, signing, or submission? 😅 we should clarify that here
There was a problem hiding this comment.
I changed this wording, and i might've been mistaken, because I think I saw it being used on a tx builder's setTimeout() method
Edit: I'm a dummy, that's not even what you were asking about hehehe
There was a problem hiding this comment.
Made an attempt at addressing this in 462e5f6
There was a problem hiding this comment.
You need it during initial simulation, but it also gets reset to this value again right before signing.
because more type definitions are more better, right?
|
Hello world |
1 similar comment
|
Hello world |
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