search

SECQUOIA / gdplib

An open library of Generalized Disjunctive Programming (GDP) models
BSD 3-Clause "New" or "Revised" License
9 stars 7 forks source link

Add documentation for distillation column model #24

Closed AlbertLee125 closed 6 months ago

AlbertLee125 commented 6 months ago

This pull request adds documentation for the distillation column model. It includes documentation for the build_model function in column.py, the initialize function in initialize.py, and the calculate_Fenske function. Additionally, it fixes a grammar error in column.py and fills in missing documentation. The documentation provides details on the purpose and parameters of each function, making it easier for developers to understand and use the code.

bernalde commented 6 months ago

@ZedongPeng I don;t know if the linter is working well, but then should we block this until it passes the test?

AlbertLee125 commented 6 months ago

@ZedongPeng It seems that I have to do the documentation in double quotes(" ") instead of single quote (' ').

ZedongPeng commented 6 months ago

I have added the -S -C arguments, so the black format check will ignore the quotes. Let me check it.

@ZedongPeng It seems that I have to do the documentation in double quotes(" ") instead of single quote (' ').

ZedongPeng commented 6 months ago

@ZedongPeng I don;t know if the linter is working well, but then should we block this until it passes the test?

Let's use the PR to test and make the linter work as expected. I will commit to this branch.

ZedongPeng commented 6 months ago

The quotes issue is resolved, but it seems that many files (not in the distillation column) do not satisfy the black format. I think we can merge this PR first and I will create a new PR to format the whole repository. @bernalde (I didn't set any rule related to Lint check, so this PR is ready to be merged.)