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

Add documentation for exclude flag #265

Merged
merged 2 commits into from
Sep 4, 2024
Merged

Add documentation for exclude flag #265

merged 2 commits into from
Sep 4, 2024

Conversation

ericvergnaud
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Sep 3, 2024

✅ 34/34 passed, 3 flaky, 3 skipped, 8m1s total

Flaky tests:

  • 🤪 test_dashboard_deploys_dashboard_with_counter_variation (7.485s)
  • 🤪 test_dashboard_deploys_dashboard_with_display_name (8.803s)
  • 🤪 test_dashboard_deploys_dashboard_with_ten_counters (9.074s)

Running from acceptance #373

@nfx nfx merged commit 4c8494b into main Sep 4, 2024
8 checks passed
@nfx nfx deleted the document-exclude-flag branch September 4, 2024 15:38
nfx added a commit that referenced this pull request Sep 4, 2024
* Added documentation for exclude flag ([#265](#265)). A new `exclude` flag has been added to the configuration of our tool/system, allowing users to specify a path to exclude from formatting, enhancing customizability. Additionally, the descriptions of the `catalog` and `database` flags have been improved for better grammar and clarity. The `exclude` flag is particularly useful in scenarios requiring separate catalogs or databases, such as for production and development. These changes provide improved clarity, readability, and utility for users in configuring and utilizing the available options. It is important to note that no new methods have been added and the existing functionality remains unchanged, except for the updated descriptions.
@nfx nfx mentioned this pull request Sep 4, 2024
nfx added a commit that referenced this pull request Sep 4, 2024
* Added documentation for exclude flag ([#265](#265)). A new `exclude` flag has been added to the configuration file for our lab tool, allowing users to specify a path to exclude from formatting during lab execution. This release also includes corrections to grammatical errors in the descriptions of existing flags related to catalog and database settings, such as updating `seperated` to "separate". Additionally, the flag descriptions for `publish` and `open-browser` have been updated for clarification: `publish` now clearly controls whether the dashboard is published after creation, while `open-browser` controls whether the dashboard is opened in a web browser. These changes are aimed at improving user experience and ease of use for our lab tool.
* Fixed dataclass field type in _row_to_sql ([#266](#266)). In this release, we have addressed an issue related to [#257](#257) by fixing the dataclass field type in the `_row_to_sql` method of the `backends.py` file. Additionally, we have made updates to the `_schema_for` method to use a new `_field_type` class method. This change resolves a rare problem where the `field.type` is a string instead of a type and ensures compatibility with a pull request from an external repository (<databrickslabs/ucx#2526>). The new `_field_type` method attempts to load the type from `__builtins__` if it's a string and logs a warning if it fails. The `_row_to_sql` method now consistently uses the `_field_type` method to get the field type. This ensures that the library functions seamlessly and consistently, avoiding any potential issues in the future.
nfx added a commit that referenced this pull request Sep 4, 2024
* Added documentation for exclude flag
([#265](#265)). A new
`exclude` flag has been added to the configuration file for our lab
tool, allowing users to specify a path to exclude from formatting during
lab execution. This release also includes corrections to grammatical
errors in the descriptions of existing flags related to catalog and
database settings, such as updating `seperated` to "separate".
Additionally, the flag descriptions for `publish` and `open-browser`
have been updated for clarification: `publish` now clearly controls
whether the dashboard is published after creation, while `open-browser`
controls whether the dashboard is opened in a web browser. These changes
are aimed at improving user experience and ease of use for our lab tool.
* Fixed dataclass field type in _row_to_sql
([#266](#266)). In this
release, we have addressed an issue related to
[#257](#257) by fixing the
dataclass field type in the `_row_to_sql` method of the `backends.py`
file. Additionally, we have made updates to the `_schema_for` method to
use a new `_field_type` class method. This change resolves a rare
problem where the `field.type` is a string instead of a type and ensures
compatibility with a pull request from an external repository
(<databrickslabs/ucx#2526>). The new
`_field_type` method attempts to load the type from `__builtins__` if
it's a string and logs a warning if it fails. The `_row_to_sql` method
now consistently uses the `_field_type` method to get the field type.
This ensures that the library functions seamlessly and consistently,
avoiding any potential issues in the future.
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

Successfully merging this pull request may close these issues.

2 participants