Skip to content

Update docs #81

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

Merged
merged 2 commits into from
Jun 26, 2023
Merged

Update docs #81

merged 2 commits into from
Jun 26, 2023

Conversation

tnorbye
Copy link
Collaborator

@tnorbye tnorbye commented Jun 26, 2023

This CL updates the documentation for the built-in lint
checks as well as the AndroidX lint checks and some new
3rd party lint checks. This was generated by the issue
metadata extraction tool which was updated as follows:

  • Includes the relevant Gradle dependencies to use to include the
    lint checks in your project.
  • Includes information about other versions of the library, including
    change notes (which checks are added in each version), compatibility
    (minimum- and compiled-with- versions of lint for each version
    of the library), license, etc.
  • A new index page listing all the availble libraries, and a dedicated
    page for each library listing which issues each library contains,
    license information, a library description, etc. extracted from the
    POM file.
  • The documentation generation code now directly pulls jars, poms and
    source files from the network; you don't have to have a checkout
    of AndroidX (or the other libraries listed below).
  • Includes additional well known 3rd party lint checks in the report,
    such as Slack's Compose lint checks.
  • Looks for ID conflicts between libraries; if a link check is found
    in separate libraries, the conflicts are listed on the issue pages
    stating that you cannot combine these libraries.
  • Fixes the code which extracts examples from unit tests such that they
    also work with lint checks which emit multi-line error messages
  • Fixes artifact handling for multi-platform dependencies ("-android").

tnorbye added 2 commits June 26, 2023 16:14
This CL updates the documentation for the built-in lint
checks as well as the AndroidX lint checks and some new
3rd party lint checks. This was generated by the issue
metadata extraction tool which was updated as follows:

* Includes the relevant Gradle dependencies to use to include the
  lint checks in your project.
* Includes information about other versions of the library, including
  change notes (which checks are added in each version), compatibility
  (minimum- and compiled-with- versions of lint for each version
  of the library), license, etc.
* A new index page listing all the availble libraries, and a dedicated
  page for each library listing which issues each library contains,
  license information, a library description, etc. extracted from the
  POM file.
* The documentation generation code now directly pulls jars, poms and
  source files from the network; you don't have to have a checkout
  of AndroidX (or the other libraries listed below).
* Includes additional well known 3rd party lint checks in the report,
  such as Slack's Compose lint checks.
* Looks for ID conflicts between libraries; if a link check is found
  in separate libraries, the conflicts are listed on the issue pages
  stating that you cannot combine these libraries.
* Fixes the code which extracts examples from unit tests such that they
  also work with lint checks which emit multi-line error messages
* Fixes artifact handling for multi-platform dependencies ("-android").
...from latest manually edited docs in the lint source tree.
@tnorbye tnorbye merged commit 3c4e7af into main Jun 26, 2023
@tnorbye tnorbye deleted the update-docs branch June 26, 2023 23:26
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.

1 participant