Skip to content

Move doc from comments to meta#407

Merged
tmigot merged 24 commits into
mainfrom
move-docstring-to-metadata
May 15, 2026
Merged

Move doc from comments to meta#407
tmigot merged 24 commits into
mainfrom
move-docstring-to-metadata

Conversation

@tmigot
Copy link
Copy Markdown
Member

@tmigot tmigot commented Feb 27, 2026

No description provided.

@tmigot
Copy link
Copy Markdown
Member Author

tmigot commented Feb 27, 2026

@arnavk23 @dpo

Comment thread src/Meta/aircrfta.jl Outdated
@tmigot
Copy link
Copy Markdown
Member Author

tmigot commented Mar 29, 2026

@dpo @arnavk23 I updated the PR to take into account the suggestions. For the specific example illustrated here, I didn't find a DOI. Ideally, the URL field would use the DOI link.
If you guys agree I can then apply to all problems.

@tmigot tmigot marked this pull request as ready for review March 29, 2026 17:30
@tmigot tmigot requested review from Copilot and dpo March 29, 2026 17:30
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR relocates the aircrfta problem’s provenance/licensing documentation from the PureJuMP implementation file into the corresponding Meta dictionary.

Changes:

  • Removed the large header comment block from src/PureJuMP/aircrfta.jl.
  • Added :url, :notes, :origin_notes, and :reference entries to src/Meta/aircrfta.jl.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/PureJuMP/aircrfta.jl Removes the embedded provenance/license header from the problem implementation file.
src/Meta/aircrfta.jl Stores the removed provenance/license information (plus URL/reference) in the problem’s metadata dict.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/PureJuMP/aircrfta.jl
Comment thread src/Meta/aircrfta.jl Outdated
@tmigot
Copy link
Copy Markdown
Member Author

tmigot commented Mar 29, 2026

Connected to #319 and #324

Copy link
Copy Markdown
Member

@dpo dpo left a comment

Choose a reason for hiding this comment

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

@tmigot I think this is excellent! Thank you. If I have

model = aircrfta()

how can I programmatically access its "meta"? Do we have something like meta(model)? Then, we could access its DOI, URL, etc.

@tmigot
Copy link
Copy Markdown
Member Author

tmigot commented Apr 16, 2026

@tmigot I think this is excellent! Thank you. If I have

model = aircrfta()

how can I programmatically access its "meta"? Do we have something like meta(model)? Then, we could access its DOI, URL, etc.

All the meta are collected together in a DataFrames accessible like this;

using OptimizationProblems
OptimizationProblems.meta

for a specific problem you could do OptimizationProblems.aircrfta_meta.
However, right now there is no logic to get the meta from the problem, but that should be doable. If you think that's relevant it could be described in a new issue.

@tmigot tmigot force-pushed the move-docstring-to-metadata branch from 320d47b to 30968a4 Compare May 1, 2026 16:54
@tmigot tmigot changed the title Move doc from comments to meta (aircrfta) Move doc from comments to meta May 4, 2026
@tmigot tmigot requested a review from Copilot May 15, 2026 12:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@tmigot tmigot force-pushed the move-docstring-to-metadata branch from 7837f47 to 49442cc Compare May 15, 2026 15:38
@tmigot tmigot merged commit eb8362a into main May 15, 2026
15 of 17 checks passed
@tmigot tmigot deleted the move-docstring-to-metadata branch May 15, 2026 16:29
BenjaminPINEAU pushed a commit to BenjaminPINEAU/OptimizationProblems.jl that referenced this pull request May 26, 2026
* Move doc from comments to meta (aircrfta)

* up

* do not move license

* add new fields in Meta

* Move comments to META

* fix

* add refs

* move things around hs

* add doc

* Add a bib creator

* fix

* fix conflict

* allow multiple URL

* fill-in meta

* up some refs

* clean COPS test problems

* clean HS2

* Fix split :origin and :origin_notes

* Add missing bibtex and links

* Add lib ref

* small fixes

* 59 files with http://dx.doi.org/https://doi.org/

* Update SKILL

* uniform bib
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants