Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Userguide: Constraints and Parameters #21

Merged
merged 10 commits into from
Dec 4, 2023
Merged

Userguide: Constraints and Parameters #21

merged 10 commits into from
Dec 4, 2023

Conversation

Scienfitz
Copy link
Collaborator

Includes Doc pages for

  • constraints
  • parameters

Other changes:

  • Enable dollarmath in doc config
  • Created dummy page for transfer learning

@Scienfitz Scienfitz self-assigned this Dec 4, 2023
AVHopp
AVHopp approved these changes Dec 4, 2023
View reviewed changes
Copy link
Collaborator

@AVHopp AVHopp left a comment

Choose a reason for hiding this comment

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

I have scanned (not read in detail!) these user guides and really like their style. Only found minor weird formulations (and note that triple backticks are no longer necessary if I am not mistaken)

docs/conf.py Outdated Show resolved Hide resolved
docs/userguide/constraints.md Outdated Show resolved Hide resolved
docs/userguide/constraints.md Outdated Show resolved Hide resolved
docs/userguide/constraints.md Outdated Show resolved Hide resolved
docs/userguide/constraints.md Show resolved Hide resolved
docs/userguide/parameters.md Outdated Show resolved Hide resolved
docs/userguide/parameters.md Outdated Show resolved Hide resolved
docs/userguide/parameters.md Outdated Show resolved Hide resolved
@AVHopp AVHopp added the documentation Improvements or additions to documentation label Dec 4, 2023
@Scienfitz Scienfitz force-pushed the docs/userguide_parameters_constraints branch 3 times, most recently from ea48a57 to e091521 Compare December 4, 2023 14:29
AdrianSosic
AdrianSosic requested changes Dec 4, 2023
View reviewed changes
Copy link
Collaborator

@AdrianSosic AdrianSosic left a comment

Choose a reason for hiding this comment

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

Have made some changes in certain phrasings. However, had no time to go through constraints.md so far

docs/userguide/parameters.md Show resolved Hide resolved
docs/userguide/parameters.md Show resolved Hide resolved
docs/userguide/parameters.md Outdated Show resolved Hide resolved
AdrianSosic
AdrianSosic reviewed Dec 4, 2023
View reviewed changes
Copy link
Collaborator

@AdrianSosic AdrianSosic left a comment

Choose a reason for hiding this comment

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

As agreed, will revise in detail after having released the first open-source version

AdrianSosic
AdrianSosic approved these changes Dec 4, 2023
View reviewed changes
Copy link
Collaborator

@AdrianSosic AdrianSosic left a comment

Choose a reason for hiding this comment

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

As agreed, will revise in detail after having released the first open-source version

@Scienfitz Scienfitz force-pushed the docs/userguide_parameters_constraints branch from f0eebb9 to c9a4929 Compare December 4, 2023 16:09
@Scienfitz Scienfitz merged commit ee47355 into main Dec 4, 2023
6 of 7 checks passed
@Scienfitz Scienfitz deleted the docs/userguide_parameters_constraints branch December 4, 2023 16:20
@Scienfitz Scienfitz restored the docs/userguide_parameters_constraints branch December 4, 2023 16:22
@Scienfitz Scienfitz deleted the docs/userguide_parameters_constraints branch December 14, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AVHopp AVHopp AVHopp approved these changes

@AdrianSosic AdrianSosic AdrianSosic approved these changes

Assignees

@Scienfitz Scienfitz

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Scienfitz @AdrianSosic @AVHopp