Skip to content

docs: add new JMLR reference to WEFE library#66

Merged
pbadillatorrealba merged 2 commits intodevelopfrom
docs/update_references
Nov 24, 2025
Merged

docs: add new JMLR reference to WEFE library#66
pbadillatorrealba merged 2 commits intodevelopfrom
docs/update_references

Conversation

@pbadillatorrealba
Copy link
Member

@pbadillatorrealba pbadillatorrealba commented Nov 24, 2025

1. Description

Updated WEFE's citation and reference information to reflect the new publication in Journal of Machine Learning Research (JMLR) in 2025. Previously, the documentation only mentioned the original IJCAI-PRICAI 2020 publication. These changes ensure that users correctly cite the most recent academic work from the library.

This update is important for keeping the documentation current and making it easier for academic users and researchers to access the correct citation information, especially relevant now that the project has a publication in a top-tier academic journal.

2. Changes

Main:

  • docs: Added new citation section for JMLR 2025 in README.rst with complete information and bibtex (4106af8)
  • docs: Added reference to JMLR publication in docs/getting_started/about.rst with proper reStructuredText formatting (4106af8)
  • docs: Cleaned and optimized README.rst by removing unnecessary blank lines and improving the citation section format (ed9368e)
  • docs: Added new JMLR reference in docs/getting_started/about.rst maintaining consistency with README (ed9368e)

Minor:

  • style: Whitespace cleanup in docs/conceptual_guides/references.rst

3. Technical Considerations

Affected areas: Main documentation (README), "About" section in Sphinx documentation, and references section

Behavior changes: No functional changes. Changes are purely documentational to reflect updated citation information.

Breaking Changes: ✅ None - documentation only changes

Compatibility: ✅ Fully backward compatible - information update only

Risks: None identified. Changes are informational only.

4. Reviewer Notes

  • ✅ Both commits follow the Conventional Commits standard correctly with docs: prefix
  • 📝 Changes are well-documented and structured
  • 🔍 Recommend verifying that JMLR links are active and correct: http://jmlr.org/papers/v26/22-1133.html
  • 💡 Bibtex is properly formatted for both publications
  • 📌 Small and focused MR (only 2 documentation commits)
  • ✅ No merge conflicts expected

5. Changed Files Summary

✏️ Modified

  • README.rst - Updated changelog and citation sections
  • docs/getting_started/about.rst - Added new citation section for JMLR 2025
  • docs/conceptual_guides/references.rst - Whitespace cleanup

📊 Statistics

README.rst                            | 32 +++++++++++++++++++++++++++-----
docs/conceptual_guides/references.rst |  1 -
docs/getting_started/about.rst        | 21 +++++++++++++++++++++
3 files changed, 48 insertions(+), 6 deletions(-)

@pbadillatorrealba pbadillatorrealba merged commit 9c2a23f into develop Nov 24, 2025
4 checks passed
@pbadillatorrealba pbadillatorrealba deleted the docs/update_references branch November 24, 2025 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant