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.

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

Overall edit of PyPDF-Core files. #452

Merged
merged 13 commits into from
Sep 8, 2022
Merged

Overall edit of PyPDF-Core files. #452

merged 13 commits into from
Sep 8, 2022

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Sep 1, 2022

Edits to example files were limited to those necessary to address style issues discovered by Vale. All content will need to be reviewed again after completion of the PR. Note that some diagrams in examples were not being generated (locally at least), and lots of formatting changes are necessary to the examples.

… to those necessary to address style issues discovered by Vale. All content will need to be reviwed again after completion of the PR. Note that some diagrams in examples were not being generated (locally at least), and lots of formatting changes are necessary to the examples.
@PipKat PipKat requested a review from PProfizi September 1, 2022 17:41
@PipKat
Copy link
Member Author

PipKat commented Sep 1, 2022

@PProfizi Lots of "Build and Test" checks failing.

@PProfizi
Copy link
Contributor

PProfizi commented Sep 2, 2022

@PProfizi Lots of "Build and Test" checks failing.

Hi @PipKat, yes this is normal, we are in the process of releasing PyPDPF-Core 0.6.0 due to a milestone, which means we had to release higher versions of its dependencies, potentially breaking the pipelines. The release should be done within two hours and everything should be working again.

@PipKat
Copy link
Member Author

PipKat commented Sep 6, 2022

@RobPasMue I don't know how these example files got into this PR. I swear it wasn't like this on Friday. It was just failing Build and Test checks.

@RobPasMue
Copy link
Member

Hi @PipKat from what I can see, the files where already there. And by updating the examples they got also updated... Probably @PProfizi can tell us a bit more. In any case, the examples files shouldn't be in the docs/source/examples/* directory. They should be in the examples folder at the root of the repository. These are all auto-generated files.

@PProfizi
Copy link
Contributor

PProfizi commented Sep 6, 2022

@PipKat @RobPasMue I am not sure when this got here, apparently there might be a commit missing somewhere where they were removed, but I've removed it and merged the current master. It should be ok now.

@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #452 (4c2d4e4) into master (b8183ec) will increase coverage by 0.37%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #452      +/-   ##
==========================================
+ Coverage   86.08%   86.45%   +0.37%     
==========================================
  Files          65       65              
  Lines        6963     6963              
==========================================
+ Hits         5994     6020      +26     
+ Misses        969      943      -26     

@PipKat
Copy link
Member Author

PipKat commented Sep 6, 2022

@PProfizi @RobPasMue YES! All checks have passed. Now for a review?

Copy link
Contributor

@PProfizi PProfizi left a comment

Choose a reason for hiding this comment

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

I think the docs/source/index.rst got mixed up as it is now made as if referring to PyDPF-Post.

docs/source/contributing.rst Outdated Show resolved Hide resolved
docs/source/contributing.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/user_guide/concepts.rst Outdated Show resolved Hide resolved
docs/source/user_guide/concepts.rst Outdated Show resolved Hide resolved
@PProfizi PProfizi added the documentation Improvements or additions to documentation label Sep 7, 2022
PipKat and others added 2 commits September 7, 2022 09:35
Apply changes from review comments

Co-authored-by: PProfizi <100710998+PProfizi@users.noreply.github.com>
Co-authored-by: PProfizi <100710998+PProfizi@users.noreply.github.com>
@PipKat
Copy link
Member Author

PipKat commented Sep 7, 2022

@PProfizi Hi, Paul. I'm sure I introduced those problems somehow when I pulled in changes from the main branch. I ended up with conflicts in these files. I'm not sure what I did wrong since it seems so long ago that I took that action, but thanks for catching the issues. I've incorporated your feedback to date and hope that you can find time to finish your review and approve the PR. Thanks!

@PipKat
Copy link
Member Author

PipKat commented Sep 7, 2022

@PProfizi The "Build and Test (3.10, ubuntu-latest" check has been running the entire day!

@PipKat PipKat merged commit 74987ea into master Sep 8, 2022
@PipKat PipKat deleted the doc/edits_DPF_doc_round2 branch September 8, 2022 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants