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

Documentation header links quick fix #7

Merged
merged 8 commits into from
Apr 1, 2022
Merged

Documentation header links quick fix #7

merged 8 commits into from
Apr 1, 2022

Conversation

nariman87
Copy link
Contributor

@nariman87 nariman87 commented Mar 31, 2022

Context for changes

  • Updated old FT-Stack links in docs header to correct FlamingPy pages. See here.

Example usage and tests

  • Not Applicable

Performance results justifying changes

  • Not Applicable

Workflow actions and tests

  • Not Applicable

Expected benefits and drawbacks

Expected benefits:

  • Header links are now pointing to correct FlamingPy pages.

Related Github issues

  • Not Applicable

Checklist and integration statements

  • My Python and C++ codes follow the coding and commenting styles of this project as indicated by existing files. Specifically, the changes conform to given black, docformatter and pylint configurations.
  • I have performed a self-review of these changes. I have checked my code and corrected misspellings to the best of my capacity. I have checked the CodeFactor score in the active branch and ensured it is B- or higher. I also confirm that I have already merged other branches into this branch as required.
  • I have added context for corresponding changes in documentation and README.md as needed.
  • I have added new workflow CI tests for corresponding changes and these pass locally for me.
  • I have updated _version.py based on semantic versioning. I recognize that the developers may create a Special Release including my changes.

@nariman87 nariman87 self-assigned this Mar 31, 2022
@nariman87 nariman87 marked this pull request as draft March 31, 2022 23:45
@codecov
Copy link

codecov bot commented Mar 31, 2022

Codecov Report

Merging #7 (a91aeca) into main (a78477e) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main       #7   +/-   ##
=======================================
  Coverage   91.04%   91.04%           
=======================================
  Files          30       30           
  Lines        1820     1820           
=======================================
  Hits         1657     1657           
  Misses        163      163           
Impacted Files Coverage Δ
flamingpy/_version.py 100.00% <100.00%> (ø)

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 a78477e...a91aeca. Read the comment docs.

@nariman87 nariman87 changed the title More documentation improvements Documentation header links quick fix Apr 1, 2022
@nariman87 nariman87 marked this pull request as ready for review April 1, 2022 02:28
@nariman87 nariman87 added documentation Improvements or additions to documentation chores Standard routines for open-source software projects owners review ready CODEOWNERS to review at earliest possible labels Apr 1, 2022
Copy link
Collaborator

@ilan-tz ilan-tz left a comment

Choose a reason for hiding this comment

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

Looks good!

@ilan-tz ilan-tz merged commit f25ebba into main Apr 1, 2022
@ilan-tz ilan-tz deleted the doc-improv branch April 1, 2022 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chores Standard routines for open-source software projects documentation Improvements or additions to documentation owners review ready CODEOWNERS to review at earliest possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants