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.

Sign up for GitHub

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

Jump to bottom

Updating documentation to describe ~= package specification #4930

Merged
merged 16 commits into from
Sep 19, 2023
Merged

Updating documentation to describe ~= package specification #4930

merged 16 commits into from
Sep 19, 2023

Conversation

ryanskeith
Copy link
Contributor

@ryanskeith ryanskeith commented Jul 10, 2023 •
edited
Loading

Description

Attempting to address this issue #4553 .

Also, made the examples more readable by making them in table format.

Checklist - did you ...

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

@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Jul 10, 2023
@ryanskeith ryanskeith changed the title Updating documentation to describe .conda packages Updating documentation to describe ~= Jul 11, 2023
@ryanskeith ryanskeith changed the title Updating documentation to describe ~= Updating documentation to describe ~= package specification Jul 11, 2023
@ryanskeith ryanskeith changed the title Updating documentation to describe ~= package specification [DRAFT] Updating documentation to describe ~= package specification Jul 11, 2023
@ryanskeith
Copy link
Contributor Author

I just need to check how the compatibility clause gets translated in a meta.yaml to make the documentation correct.

@beeankha beeankha marked this pull request as draft July 13, 2023 19:19
@ryanskeith
Copy link
Contributor Author

ryanskeith commented Sep 15, 2023 •
edited
Loading

BEFORE SHOT:
Screenshot 2023-09-15 at 1 51 27 PM
AFTER SHOT:
Screenshot 2023-09-15 at 1 51 41 PM

@ryanskeith ryanskeith changed the title [DRAFT] Updating documentation to describe ~= package specification Updating documentation to describe ~= package specification Sep 15, 2023
beeankha
beeankha previously approved these changes Sep 16, 2023
View reviewed changes
Copy link
Member

@beeankha beeankha left a comment

Choose a reason for hiding this comment

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

These changes look great!

@ryanskeith @jezdez
Update news/4553-document-compatibility-release-operator
9caffbd 
Co-authored-by: Jannis Leidel <jannis@leidel.info>
kathatherine
kathatherine requested changes Sep 18, 2023
View reviewed changes
Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

Some suggestions and a few questions/comments. Thanks, Ryan!

docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
ryanskeith and others added 6 commits September 18, 2023 13:21
@ryanskeith
Remove raw html and moving some examples to a better section.
2532a2b
@ryanskeith @kathatherine
Update docs/source/resources/package-spec.rst
c2d94b0 
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
@ryanskeith @kathatherine
Update docs/source/resources/package-spec.rst
0e247d1 
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
@ryanskeith @kathatherine
Update docs/source/resources/package-spec.rst
263c9f7 
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
@ryanskeith @kathatherine
Update docs/source/resources/package-spec.rst
70ebb8f 
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
@ryanskeith @kathatherine
Update docs/source/resources/package-spec.rst
37a3724 
Co-authored-by: Katherine Kinnaman <kkinnaman@anaconda.com>
kathatherine
kathatherine reviewed Sep 18, 2023
View reviewed changes
Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

A few more things

docs/source/resources/package-spec.rst Show resolved Hide resolved
docs/source/resources/package-spec.rst Outdated Show resolved Hide resolved
@ryanskeith ryanskeith marked this pull request as ready for review September 18, 2023 22:04
kathatherine
kathatherine approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

Thanks!

@jezdez jezdez merged commit 3ba167b into conda:main Sep 19, 2023
@ryanskeith ryanskeith deleted the issue/4553 branch September 19, 2023 19:43
@kenodegard kenodegard mentioned this pull request Sep 26, 2023
Closed
36 tasks
@github-actions github-actions bot added the locked [bot] locked due to inactivity label Sep 19, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jezdez jezdez jezdez left review comments

@kathatherine kathatherine kathatherine approved these changes

@beeankha beeankha beeankha left review comments

Assignees
No one assigned
Labels
cla-signed [bot] added once the contributor has signed the CLA locked [bot] locked due to inactivity
Projects
🔎 Review
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ryanskeith @jezdez @beeankha @kathatherine @conda-bot