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

ANW-1388 Add subject merge api examples #2519

Merged
merged 1 commit into from Nov 9, 2021

Conversation

lorawoodford
Copy link
Contributor

Adds shell and python examples to the API documentation for the merge subjects endpoint. The python example is directly copied from what was supplied in JIRA.

Description

Related JIRA Ticket or GitHub Issue

https://archivesspace.atlassian.net/browse/ANW-1388

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have read the CONTRIBUTING document.
  • I have authority to submit this code.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@lorawoodford lorawoodford added documentation The issue or pull request specifically and primarily deals with documentation API labels Nov 9, 2021
Copy link
Collaborator

@quoideneuf quoideneuf left a comment

Choose a reason for hiding this comment

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

😃 🐍

@quoideneuf quoideneuf merged commit d2fdcac into archivesspace:master Nov 9, 2021
@lorawoodford lorawoodford deleted the ANW-1388 branch November 11, 2021 19:05
@crugas
Copy link
Contributor

crugas commented Jan 24, 2022

@quoideneuf Just FYI, I updated the JIRA awhile back (https://archivesspace.atlassian.net/browse/ANW-1388?focusedCommentId=37913) to add some comments in the python code to make it easier for people to understand the example. If this would be better to add after 3.2.0 release, just let me know and I can make a small pull request to update it.

@quoideneuf
Copy link
Collaborator

@crugas - It is fine to add anytime. We aren't accepting any more changes to the 3.2.0 release unless they are necessary, but you can submit to the master branch now.

@crugas
Copy link
Contributor

crugas commented Feb 4, 2022

@quoideneuf Made a pull request here: #2632. Let me know if you have any questions or need me to redo the code/pull request. Thanks!

quoideneuf pushed a commit that referenced this pull request Feb 25, 2022
Update merge subject api python example for #2519
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API documentation The issue or pull request specifically and primarily deals with documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants