Skip to content

Add library specification to library tutorial #289

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 3 commits into from
Jun 28, 2022
Merged

Add library specification to library tutorial #289

merged 3 commits into from
Jun 28, 2022

Conversation

gvenzl
Copy link
Contributor

@gvenzl gvenzl commented Jun 11, 2022

This PR includes a reference to the library specification at the end of the article.

What This PR Changes

  • The library creation tutorial is great but lacks information on how to make the library available in the library manager. This PR adds a link to the library specification at the end of the tutorial.

Contribution Guidelines

gvenzl added 2 commits June 11, 2022 09:33
This PR includes a reference to the library specification at the end of the article.
Include library reference in library guide
@CLAassistant
Copy link

CLAassistant commented Jun 11, 2022

CLA assistant check
All committers have signed the CLA.

Add link to the Library Manager FAQ
Fix typo
@gvenzl
Copy link
Contributor Author

gvenzl commented Jun 11, 2022

Fixes parts of #236

@per1234
Copy link
Contributor

per1234 commented Jun 11, 2022

Thanks @gvenzl!

Although this does address some of the requests made in #236, it is missing this part:

with a library.properties example, and probably using the src/ subfolder

So I'm not sure it could be considered a complete resolution to #236.

CC: @matthijskooijman

@gvenzl
Copy link
Contributor Author

gvenzl commented Jun 11, 2022

Hi @per1234,

You are correct, it does not include that part.

I'm somewhat with @matthijskooijman, the tutorial probably should be overhauled in general, although note that the last revision date was the 23rd of May, just a couple of weeks ago.

Still, issue #236 open since 2016 and I just happened to run into the very same problem as well, spending half an hour trying to find the right information.
There seems to be no harm to at least adding this paragraph, for now, to help save other users some time, even if a bigger rewrite is coming in the future.

@per1234
Copy link
Contributor

per1234 commented Jun 11, 2022

There seems to be no harm to at least adding this paragraph, for now, to help save other users some time, even if a bigger rewrite is coming in the future.

I completely agree. I only made my previous reply to indicate that we should not necessarily consider #236 100% resolved by this PR.

That doesn't mean this PR is required to provide a 100% resolution, only that we should not close #236 if there are still unresolved components.

@gvenzl
Copy link
Contributor Author

gvenzl commented Jun 12, 2022

Gotcha! I've updated my previous comment to reflect that.

@jhansson-ard jhansson-ard requested a review from per1234 June 14, 2022 06:44
@jhansson-ard jhansson-ard added enhancement New feature or request community Bugs and fixes suggested by the community labels Jun 14, 2022
Copy link
Member

@marqdevx marqdevx left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

Thanks @gvenzl!

@jhansson-ard jhansson-ard merged commit a476674 into arduino:main Jun 28, 2022
Serjlee pushed a commit that referenced this pull request Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Bugs and fixes suggested by the community enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants