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

Feature 313 consistent headers #316

Merged
merged 20 commits into from
Jul 24, 2023
Merged

Conversation

lisagoodrich
Copy link
Contributor

@lisagoodrich lisagoodrich commented Jul 17, 2023

Pull Request Testing

  • Describe testing already performed for these changes:
    All of the chapters, sections and sub-sections are consistent across the different chapters. METcalcpy/docs/index.rst and METcalcpy/docs/Users_Guide/index.rst files have been updated to include ### for the title. Please note, there are no chapter sections in the index files. It will mess up the Table of Contents formatting in the left side menu window.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
    Please confirm all of the chapter, section and sub-section changes are accurate. Here is the feature branch web page: https://metcalcpy.readthedocs.io/en/feature_313_consistent_headers/Contributors_Guide/index.html

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes] there are no errors in the build code.

  • Do these changes include sufficient testing updates? [Yes]

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • Please complete this pull request review by [7/21/23].

Pull Request Checklist

See the METplus Workflow for details.

  • Review the source issue metadata (required labels, projects, and milestone). Please change the project if I picked the wrong one.
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

lisagoodrich and others added 18 commits June 7, 2023 15:45
Changing the heading formatting to match sphinx and METplus User's Guide documentation.
Changing the heading formatting to match sphinx and METplus User's Guide documentation.
Changing the heading formatting to match sphinx and METplus User's Guide documentation.
Left bolded sections alone.  Are these sub-subsections?
…METcalcpy into feature_313_consistent_headers
switching back to bolding from chapters in hopes of getting rid of an error message.
Changing chapter headers back to bolding in hopes of getting rid of an error message
@lisagoodrich lisagoodrich added the component: documentation Documentation issue label Jul 17, 2023
@lisagoodrich lisagoodrich added this to the METcalcpy 2.1.0 milestone Jul 17, 2023
@lisagoodrich lisagoodrich requested a review from jprestop July 17, 2023 18:04
@lisagoodrich lisagoodrich linked an issue Jul 17, 2023 that may be closed by this pull request
7 tasks
Copy link
Collaborator

@jprestop jprestop 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 reviewed the changes and approve this request. Thank you for all of your work on this @lisagoodrich.

@jprestop jprestop merged commit fe47753 into develop Jul 24, 2023
@jprestop jprestop deleted the feature_313_consistent_headers branch July 24, 2023 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Documentation: Make Headers Consistent in METcalcpy User's Guides
3 participants