Spock documentation improvement attempt #177
Conversation
danolivo
force-pushed
the
docs-improvement-1
branch
from
b746865 to
6ac33e5
Compare
| location | ||
| (optional) Text string identifying the node location as precise as needed. Doesn't affect any internal logic. | ||
| country | ||
| (optional) Text string dedicated to conveniently store and expose the country code where the spock node is located. Doesn't affect any internal logic. |
There was a problem hiding this comment.
Text string dedicated to conveniently store and expose
should be
Text string dedicated to conveniently storing and exposing
susan-pgedge
left a comment
susan-pgedge
left a comment
There was a problem hiding this comment.
Looks pretty good Andrei, just a couple of comments!
danolivo
force-pushed
the
docs-improvement-1
branch
2 times, most recently
from
b40a794 to
26fdf60
Compare
|
I understand wanting to improve the parameter names, but I am hesitant to break anyone's scripts if they are using named parameters in calls such as Can you please do a doc only PR, without any C file changes first? |
- Add some internal details on what exactly the routine does. - Each parameter is briefly explained - The spock_country_code GUC is obsolete and removed. - Minor changes caused by automatic trailing backspace removal
Some typo corrections in different places of the code are also included here.
…unctions. Some minor typos and trailed whitespaces fixed here and there in the code. Also, this commit commences restructurisation of the UI .sql script to make it a little more readable and synced with the docs/spock_functions.md.
- Revert fixes of code style and typos in c-files.
danolivo
force-pushed
the
docs-improvement-1
branch
from
8364320 to
9a8c4d0
Compare
Not sure about the reason, but done. |
| | spock.spock_version | Returns the Spock version in a major/minor version form: `4.0.10`. | ||
| | spock.spock_version_num | Returns the Spock version in a single numeric form: `40010`. | ||
| | spock.get_channel_stats | Returns tuple traffic statistics. | ||
| | spock.get_country | Returns the country code if explicitly set; returns `??` if not set. |
There was a problem hiding this comment.
I confirmed with Asif, that we should NOT remove this. Thanks.
By this we revise UI Spock functions and improve their documentation.