Skip to content

doc: update askrene constraint descriptions #9395

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

Open
VirajsNexus wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: update askrene constraint descriptions #9395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions doc/schemas/askrene-age.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"title": "Command for expiring information in a layer",
"added": "v24.11",
"description": [
"The **askrene-age** RPC command tells askrene that information added to a layer by *askrene-inform-channel* and *askrene-bias-channel* beyond a certain age is less useful. It currently completely forgets constraints and biases older than *cutoff*."
"The **askrene-age** RPC command tells askrene that information added to a layer by *askrene-inform-channel* and *askrene-bias-channel* beyond a certain age is less useful. It currently completely forgets constraints, impressions, and biases older than *cutoff*."
],
"request": {
"required": [
Expand All @@ -23,7 +23,7 @@
"cutoff": {
"type": "u64",
"description": [
"The UNIX timestamp: constraints older than this will be forgotten."
"The UNIX timestamp: constraints and impressions older than this will be forgotten."
]
}
}
Expand All @@ -44,7 +44,7 @@
"num_removed": {
"type": "u64",
"description": [
"The number of constraints removed from *layer*"
"The number of constraints and impressions removed from *layer*"
]
Comment on lines 44 to 48
}
}
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/askrene-create-layer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@
"timestamp": {
"type": "u64",
"description": [
"The UNIX timestamp when this constraint was created."
"The UNIX timestamp when this impression was created."
]
},
"amount_msat": {
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/askrene-inform-channel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
"timestamp": {
"type": "u64",
"description": [
"The UNIX timestamp when this constraint was created."
"The UNIX timestamp when this impression was created."
]
},
"amount_msat": {
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/askrene-listlayers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@
"timestamp": {
"type": "u64",
"description": [
"The UNIX timestamp when this constraint was created."
"The UNIX timestamp when this impression was created."
]
},
"amount_msat": {
Expand Down