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

Fix/doc improvements #394

Merged
merged 16 commits into from
Feb 26, 2024
Merged

Fix/doc improvements #394

merged 16 commits into from
Feb 26, 2024

Conversation

TobiasAdler
Copy link
Collaborator

Description

  • Replaced 'sensible data' with 'sensitive data' since the term 'sensible' fails to provide an accurate depiction of the nature of that data
  • Set sensible data methods @Deprecated
  • Updated 'sensible data' to 'sensitive data' in docs
  • Removed unnecessary unique() call in 'Radio buttons' section of documentation since the value already makes it unique and the call would require the Locator to be casted to PreparedLocator
  • Added 'Timings View' section to docs
  • Updated LayoutCheck pixel comparison screenshot in docs

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@@ -113,15 +114,26 @@ public GuiElementData setHasShadowRoot(boolean shadowRoot) {
return this;
}

@Deprecated
public boolean hasSensibleData() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class is for internal use only. It's not needed to mark method as deprecated. We can rename it immediatly.

docs/src/docs/reports/timings-view.adoc Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please find an example with "base URL" dots.

@martingrossmann martingrossmann merged commit 4d067a5 into master Feb 26, 2024
@martingrossmann martingrossmann deleted the fix/doc-improvements branch February 26, 2024 13:42
@martingrossmann martingrossmann added this to the 2.8 milestone Feb 27, 2024
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