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

Update marks.sync docs for confirm:true and non-subscriptability #507

Merged
merged 1 commit into from
Jan 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 7 additions & 16 deletions docs/scripting/trust_scripts/marks.sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ NULLSEC
### CLI

```
marks.sync
marks.sync {confirm:true}
```

### Script

```
#ns.marks.sync()
```
Cannot be called as a subscript.

### Parameters

No known parameters.
#### confirm (required)

The '((%Nconfirm%))' parameter confirms syncing of your marks to the end of the required marks.

### Return

Expand All @@ -35,7 +35,7 @@ Returns a string.

```
>>marks.sync
You have fast-forwarded to the end of the marks progression.
Your `Qprotocol` has been fast-forwarded to the end of Trust's required `Qmarks`.

Mark :::not_yet_obtained_required_mark::: earned - view further training with marks.available

Expand All @@ -44,13 +44,4 @@ Mark :::not_yet_obtained_required_mark::: earned - view further training with ma

#### Script

Same as CLI.

## Example

```js
function(context, args)
{
return #ns.marks.sync()
}
```
Cannot be called as a subscript.
Loading