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

Click Table Result "link" to view associated data. #139

Open
jdjohn555 opened this issue Jan 21, 2025 · 1 comment
Open

Click Table Result "link" to view associated data. #139

jdjohn555 opened this issue Jan 21, 2025 · 1 comment

Comments

@jdjohn555
Copy link

I want to be able to query a function e.g. getTodaysPrices[]


date ticker exchange bid ask weblink exchangeinfo
2011.01.01 GOOG LSE 1.1 2.2 http://google.com
2011.01.01 META NYSE 1.1 2.2 META@NYSE

and then

  • Click GOOG to go see information on GOOG
  • Click on the weblink column to go to that web page
  • CLick on Meta@NYSE to make the API call getBidAsk[ NYSE; META]

This should be javadoc driven and based on column names e.g.

// @return table of date ticker ...
// @result-lookup exchange getExchangeInfo[exchange]
// @result-lookup [exchange,ticker] getBidAsk[ exchange; ticker]
getTodaysPrices:{}

A way of documenting links between API calls and showing them to user.

3 Types of link:

  1. If table returned contains nested kdb structure allow clicking to expand into that structure.
  2. A query link, that sends another kdb query.
  3. An HTTP link, that opens a web page.
@jdjohn555
Copy link
Author

Display docpage per namespace when browsing. Use #140 and these links to generate useful links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant