Skip to content

FIX links to pcs formats#231

Merged
mfeurer merged 3 commits intomasterfrom
FIX#220_document_pcs
Feb 4, 2022
Merged

FIX links to pcs formats#231
mfeurer merged 3 commits intomasterfrom
FIX#220_document_pcs

Conversation

@KEggensperger
Copy link
Copy Markdown

@KEggensperger KEggensperger commented Jan 31, 2022 •
edited by mfeurer
Loading

Fixes #231.

@KEggensperger KEggensperger requested a review from mfeurer January 31, 2022 16:41
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 31, 2022 •
edited
Loading

Codecov Report

Merging #231 (9305fe2) into master (5842d4d) will increase coverage by 0.04%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #231      +/-   ##
==========================================
+ Coverage   67.11%   67.15%   +0.04%     
==========================================
  Files          17       17              
  Lines        1627     1629       +2     
==========================================
+ Hits         1092     1094       +2     
  Misses        535      535
Impacted Files Coverage Δ
ConfigSpace/read_and_write/pcs.py 85.53% <100.00%> (+0.06%) ⬆️
ConfigSpace/read_and_write/pcs_new.py 90.93% <100.00%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5842d4d...9305fe2. Read the comment docs.

mfeurer
mfeurer requested changes Feb 1, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@mfeurer mfeurer left a comment

Choose a reason for hiding this comment

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

Thanks a lot. Could you please also add these links into the docstring of the serialization classes so that they're easy to find there, too?

@mfeurer mfeurer requested a review from eddiebergman February 4, 2022 15:24
@mfeurer
Copy link
Copy Markdown
Contributor

mfeurer commented Feb 4, 2022

Hey @eddiebergman I just moved the documentation into module docstrings so that they are

  1. available in the code and the rendered documentation
  2. but only stored in one place (docstring)

What do you think?

eddiebergman
eddiebergman approved these changes Feb 4, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@eddiebergman eddiebergman left a comment

Choose a reason for hiding this comment

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

Seems good to me, as long as it renders correctly in the docs, I'm happy with it :)

@mfeurer
Copy link
Copy Markdown
Contributor

mfeurer commented Feb 4, 2022

That's the output:
image

@eddiebergman
Copy link
Copy Markdown
Contributor

eddiebergman commented Feb 4, 2022

That's nice, big approve :)

@mfeurer mfeurer merged commit 560653f into master Feb 4, 2022
@mfeurer mfeurer deleted the FIX#220_document_pcs branch February 4, 2022 16:05
@mfeurer mfeurer mentioned this pull request Feb 4, 2022
Closed
github-actions bot pushed a commit that referenced this pull request Feb 4, 2022
Katharina Eggensperger: FIX links to pcs formats (#231)
7e07cdd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mfeurer mfeurer mfeurer approved these changes

@eddiebergman eddiebergman eddiebergman approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@KEggensperger @mfeurer @eddiebergman