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

add Footer & Header clarification to docs #1644

Merged
merged 1 commit into from
Sep 3, 2023

Conversation

fnickels
Copy link
Contributor

@fnickels fnickels commented Sep 2, 2023

PR Details

improve documentation related to SetHeaderFooter field use

Description

The existing documentation does not identify the fields to be used when just wanting to set a simple header or footer to the page layout. It is not obvious to folks who are not familiar with the inner data layout of Excel's data structures that 'OddFooter' and 'OddHeader' are overloaded as the primary fields to be referenced if only using one header and footer in the sheet.

Related Issue

Motivation and Context

How Has This Been Tested

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@xuri xuri added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 3, 2023
@codecov-commenter
Copy link

codecov-commenter commented Sep 3, 2023

Codecov Report

Merging #1644 (f47f963) into master (3b2b8ca) will not change coverage.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the GitHub App Integration for your organization. Read more.

@@           Coverage Diff           @@
##           master    #1644   +/-   ##
=======================================
  Coverage   98.91%   98.91%           
=======================================
  Files          31       31           
  Lines       26482    26482           
=======================================
  Hits        26194    26194           
  Misses        191      191           
  Partials       97       97           
Flag Coverage Δ
unittests 98.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
sheet.go 100.00% <ø> (ø)

Copy link
Member

@xuri xuri left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution.

@xuri xuri merged commit ff5657b into qax-os:master Sep 3, 2023
32 checks passed
jenbonzhang pushed a commit to jenbonzhang/excelize that referenced this pull request Oct 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants