-
Notifications
You must be signed in to change notification settings - Fork 22
[master < E-meta] Add MAGE meta module docs #1017
base: master
Are you sure you want to change the base?
Conversation
mage/query-modules/cpp/meta.md
Outdated
|
||
### Procedures | ||
|
||
## stats |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## stats | |
## `stats()` |
If it's a procedure?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stats is not a procedure but it made sense to me to write about it since stats_online and stats_offline do the same thing (described in stats) so I wrote it as some sort of summary
mage/query-modules/cpp/meta.md
Outdated
- stats_online - works in **O(1)** and requires setting up a trigger | ||
- stats_offline - traverses the whole graph |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- stats_online - works in **O(1)** and requires setting up a trigger | |
- stats_offline - traverses the whole graph | |
- `stats_online` - works in **O(1)** and requires setting up a trigger | |
- `stats_offline` - traverses the whole graph |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you listing the same outputs three times then?
I don't think i would do that... i would just have stats online and offline and then this knowledge
- stats_online - works in O(1) and requires setting up a trigger
- stats_offline - traverses the whole graph
can be in the intro, or each in its own section.
It's confusing like this + different from all the other mage pages
mage/query-modules/cpp/meta.md
Outdated
|
||
### `stats_offline()` | ||
|
||
Retrieves the graph metadata by traversing the whole graph. *stats_online* should be preferred because of the better complexity unless you don't want to use triggers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Retrieves the graph metadata by traversing the whole graph. *stats_online* should be preferred because of the better complexity unless you don't want to use triggers. | |
Retrieves the graph metadata by traversing the whole graph. `stats_online` should be preferred because of the better complexity unless you don't want to use triggers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think i would have just online and offline headings, without the summary stats
This was already in the util category |
Description
Add MAGE meta module docs
Pull request type
Please delete options that are not relevant and check the ones that are.
Related PRs and issues
PR this doc page is related to:
PR296
Closes (link to issue):
Checklist: