Skip to content

[skip changelog] Add link to library dependency resolution process docs from library specification #842

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 1 commit into from
Jul 21, 2020
Merged

[skip changelog] Add link to library dependency resolution process docs from library specification #842

merged 1 commit into from
Jul 21, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 20, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Docs update.

  • What is the current behavior?

Many of the things documented in the library specification are used as determining factors in library dependency resolution. An understanding of how the components of a library influence dependency resolution priorities can be very helpful to a library developer. However, they might not think to look for valuable information about libraries in the "Sketch build process" documentation.

The "See also" section of the Arduino library specification consists of only a single link.

  • What is the new behavior?

A link to the relevant section of the sketch build process documentation is provided by the Arduino library specification.

The "See also" section of the Arduino library specification is filled out a bit more.

  • Does this PR introduce a breaking change?

No.

  • Other information:

The link text "Library dependency resolution process documentation" is a bit long winded. If anyone has a suggestion for something shorter that still gets the point across, I'm glad to hear it.

…pecification

Many of the things documented in the library specification are used as determining factors in library dependency resolution. An understanding of how the components of a library influence dependency resolution priorities can be very helpful to a library developer.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 20, 2020
Copy link
Member

@cmaglie cmaglie left a comment

Choose a reason for hiding this comment

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

The link text "Library dependency resolution process documentation" is a bit long winded. If anyone has a suggestion for something shorter that still gets the point across, I'm glad to hear it.

IMHO it's OK

@per1234 per1234 merged commit e2af8d5 into arduino:master Jul 21, 2020
@per1234 per1234 deleted the dependency-resolution-docs-link branch July 23, 2020 12:52
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants