Skip to content

Conversation

knguyen1
Copy link
Contributor

Summary

This is a…

  • Correction
  • Addition
  • Restructuring
  • Minor / simple change (like a typo)
  • Other

Reason for the Change

Added comprehensive documentation for the new custom columns feature in Picard. This addresses the need for user and developer documentation for the custom columns functionality that was implemented in the main Picard project.

Description of the Change

Added two new documentation files:

  1. User Documentation (usage/custom_columns.rst):

    • Complete user guide for creating and managing custom columns
    • Step-by-step instructions for using the Custom Columns Manager
    • Examples for both Field Reference and Script columns
    • Best practices, troubleshooting, and common patterns
    • References to main scripting and variables documentation
  2. API Documentation (extending/custom_columns_api.rst):

    • Complete developer reference for the custom columns API
    • Code examples and integration patterns
    • Factory functions, sorting adapters, and persistence utilities
    • References to implementation details

Updated navigation and index files to include the new documentation in appropriate sections.

References to implementation PRs:

Additional Action Required

None required. The documentation is complete and ready for use.

@rdswift
Copy link
Collaborator

rdswift commented Aug 27, 2025

Thanks for this. Can you please set the target branch to metabrainz:version_3_changes instead of metabrainz:master for this PR? We're trying to gather all approved Picard 3 changes into a separate branch to do a single merge when Picard 3 is released, and hopefully avoid multiple conflicts wiith each individual PR. This will also allow corrections and updates to the v2.x documentation (currently in the master branch) until we're ready to release Picard 3.

Also, how do you want to be identified in the acknowledgements page?

@rdswift rdswift added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 27, 2025
@rdswift rdswift added this to the 3.0 milestone Aug 27, 2025
@knguyen1 knguyen1 changed the base branch from master to version_3_changes August 28, 2025 00:02
@knguyen1 knguyen1 changed the base branch from version_3_changes to master August 28, 2025 00:03
@knguyen1 knguyen1 force-pushed the feat/picard-2103/add-custom-columns-documentation branch from c31e612 to 7577d8b Compare August 28, 2025 00:23
@knguyen1 knguyen1 changed the base branch from master to version_3_changes August 28, 2025 00:23
@knguyen1
Copy link
Contributor Author

Thanks for this. Can you please set the target branch to metabrainz:version_3_changes instead of metabrainz:master for this PR?

Okay, I rebased and pointed it at metabrainz:version_3_changes.

Also, how do you want to be identified in the acknowledgements page?

Just my username is fine: knguyen1. Thanks.

@rdswift
Copy link
Collaborator

rdswift commented Aug 28, 2025

Just my username is fine: knguyen1.

Added into the master branch. It will appear the next time we publish. Thanks again.

@knguyen1
Copy link
Contributor Author

knguyen1 commented Sep 4, 2025

FYI don't merge this yet. Waiting on metabrainz/picard#2714 which is still in flux.

@knguyen1
Copy link
Contributor Author

I think you can review and merge now. The PR metabrainz/picard#2714 is pretty much done. These documentations reflect the latest changes. see: Update api/usage documentation to latest @rdswift @phw

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants