docs(ast): update the note regarding the ast_codegen markers. (#4149)

This commit is contained in:
rzvxa 2024-07-09 22:52:08 +00:00
parent daea29c0da
commit bdcc2986f7
4 changed files with 12 additions and 8 deletions

View file

@ -1,5 +1,6 @@
// NB: `#[visited_node]` and `#[scope]` attributes on AST nodes do not do anything to the code in this file.
// They are purely markers for codegen used in `oxc_traverse`. See docs in that crate.
// NB: `#[span]`, `#[scope(...)]`, `#[visit(...)]`, `#[visit_as(...)]` and `#[visit_args(...)]` do
// not do anything to the code, They are purely markers for codegen used in
// `tasts/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in that crate.
// Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
#![allow(non_snake_case)]

View file

@ -1,7 +1,8 @@
//! [JSX](https://facebook.github.io/jsx)
// NB: `#[visited_node]` and `#[scope]` attributes on AST nodes do not do anything to the code in this file.
// They are purely markers for codegen used in `oxc_traverse`. See docs in that crate.
// NB: `#[span]`, `#[scope(...)]`, `#[visit(...)]`, `#[visit_as(...)]` and `#[visit_args(...)]` do
// not do anything to the code, They are purely markers for codegen used in
// `tasts/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in that crate.
// Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
#![allow(non_snake_case)]

View file

@ -1,7 +1,8 @@
//! Literals
// NB: `#[visited_node]` and `#[scope]` attributes on AST nodes do not do anything to the code in this file.
// They are purely markers for codegen used in `oxc_traverse`. See docs in that crate.
// NB: `#[span]`, `#[scope(...)]`, `#[visit(...)]`, `#[visit_as(...)]` and `#[visit_args(...)]` do
// not do anything to the code, They are purely markers for codegen used in
// `tasts/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in that crate.
// Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
#![allow(non_snake_case)]

View file

@ -3,8 +3,9 @@
//! [AST Spec](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/ast-spec)
//! [Archived TypeScript spec](https://github.com/microsoft/TypeScript/blob/3c99d50da5a579d9fa92d02664b1b66d4ff55944/doc/spec-ARCHIVED.md)
// NB: `#[visited_node]` and `#[scope]` attributes on AST nodes do not do anything to the code in this file.
// They are purely markers for codegen used in `oxc_traverse`. See docs in that crate.
// NB: `#[span]`, `#[scope(...)]`, `#[visit(...)]`, `#[visit_as(...)]` and `#[visit_args(...)]` do
// not do anything to the code, They are purely markers for codegen used in
// `tasts/ast_codegen` and `crates/oxc_traverse/scripts`. See docs in that crate.
// Silence erroneous warnings from Rust Analyser for `#[derive(Tsify)]`
#![allow(non_snake_case)]