Skip to content

Commit

Permalink
Move target universe doc to how to guide
Browse files Browse the repository at this point in the history
Summary: Move target universe doc to how to guide

Reviewed By: perehonchuk

Differential Revision: D67177428

fbshipit-source-id: a3202be2fa407390c0af9bc43f2831ae3959dd2e
  • Loading branch information
Nero5023 authored and facebook-github-bot committed Dec 18, 2024
1 parent bd4ca94 commit f3875ca
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/bxl/explanation/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ instead.

Querying the configured graph means that configurations have been applied to the
target graph. For cquery, we require that users use a
[target universe](../../target_universe) for their query inputs.
[target universe](../../how_tos/how_to_use_target_universe) for their query
inputs.

#### Aquery

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
id: target_universe
title: Target Universe in BXL
id: how_to_use_target_universe
title: How to Use Target Universe in BXL
---

## BXL cquery and target universe

BXL cannot infer the [target universe](../concepts/glossary.md#target-universe)
like in the CLI (in most cases). BXL splits up cquery functions per function
(ex: `ctx.cquery().kind(...)`), with the exception of `ctx.cquery.eval(...)`,
which accepts literals exactly like in the CLI. For the `eval` query, target
universe is inferred exactly like the CLI.
BXL cannot infer the
[target universe](../../concepts/glossary.md#target-universe) like in the CLI
(in most cases). BXL splits up cquery functions per function (ex:
`ctx.cquery().kind(...)`), with the exception of `ctx.cquery.eval(...)`, which
accepts literals exactly like in the CLI. For the `eval` query, target universe
is inferred exactly like the CLI.

For all other cases, take the following query as an example:

Expand Down
8 changes: 1 addition & 7 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,16 +176,10 @@ export const sidebars: SidebarsConfig = {
'bxl/how_tos/how_to_handle_errors',
'bxl/how_tos/how_to_catch_building_artifacts_errors',
'bxl/how_tos/how_to_run_actions_based_on_the_content_of_artifact',
'bxl/how_tos/how_to_use_target_universe',
'bxl/how_tos/how_to_collect_telemetry_events'
]
},
{
type: 'category',
label: 'User Guide',
items: [
'bxl/target_universe',
],
},
{
type: 'category',
label: 'Explanation',
Expand Down

0 comments on commit f3875ca

Please sign in to comment.