Skip to content

Conversation

@frrad
Copy link
Contributor

@frrad frrad commented Apr 5, 2025

Currently this page https://coin-or.github.io/pulp/CaseStudies/a_set_partitioning_problem.html from the docs is messed up as a result of #819 moving some line numbers around.

This PR fixes the docs and moves to a new style which uses special comments to avoid this happening again in the future. The potential drawback is that the bit at the end where it includes the full file content will now also include these special comments and look a bit funky. I personally think it's worth it but curious on your take.

I suspect there are other docs which are damaged in this same way. Happy to fix but wanted to get your take on the new approach before I do the rest.

frrad added 7 commits April 5, 2025 00:08
* initial pass

* black + isort

* add ignores in pulp.py and pulp/__init__.py

* start fixing mypy errors

* fix some mypy

* mypy passes

* move Pattern class definition to be before use
@frrad frrad marked this pull request as ready for review April 5, 2025 07:49
@pchtsp
Copy link
Collaborator

pchtsp commented Apr 8, 2025

Thanks. I think it's ok, go ahead with the rest of examples.

@frrad
Copy link
Contributor Author

frrad commented Apr 9, 2025

I converted one further example and verified that #819 does not move lines around in the remaining files which use literalInclude by line number (a_two_stage_production_planning_problem.rst, a_transportation_problem.rst, a_sudoku_problem.rst).

@pchtsp pchtsp merged commit 6c347a4 into coin-or:master Apr 9, 2025
14 checks passed
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.

2 participants