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 undocumented about section fields (meta.yaml documentation) #5215

Merged
merged 2 commits into from
Mar 19, 2024

Conversation

ytausch
Copy link
Contributor

@ytausch ytausch commented Mar 5, 2024

Description

The about section had some fields undocumented (most of them only in the example in the beginning of the documentation). These are added here.

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@ytausch ytausch requested a review from a team as a code owner March 5, 2024 15:28
@conda-bot
Copy link
Contributor

We require contributors to sign our Contributor License Agreement and we don't have one on file for @ytausch.

In order for us to review and merge your code, please e-sign the Contributor License Agreement PDF. We then need to manually verify your signature, merge the PR (conda/infrastructure#890), and ping the bot to refresh the PR.

@beeankha
Copy link
Member

beeankha commented Mar 5, 2024

@conda-bot check

@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Mar 5, 2024
@beeankha beeankha added type::documentation request for improved documentation source::community catch-all for issues filed by community members labels Mar 7, 2024
Copy link
Contributor

@ryanskeith ryanskeith left a comment

Choose a reason for hiding this comment

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

These look ok to to me as well.

@beeankha beeankha merged commit cd42a49 into conda:main Mar 19, 2024
12 checks passed
(bsdiff4, bspatch4) and tests.
dev_url: https://github.com/ilanschnell/bsdiff4
doc_url: https://bsdiff4.readthedocs.io
doc_source_url: https://github.com/ilanschnell/bsdiff4/blob/main/README.rst
Copy link
Member

Choose a reason for hiding this comment

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

Should we add license_url too?

Suggested change
doc_source_url: https://github.com/ilanschnell/bsdiff4/blob/main/README.rst
doc_source_url: https://github.com/ilanschnell/bsdiff4/blob/main/README.rst
license_url: https://github.com/ilanschnell/bsdiff4/blob/master/LICENSE

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. #5250

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed [bot] added once the contributor has signed the CLA source::community catch-all for issues filed by community members type::documentation request for improved documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants