Skip to content

Move special cases to notes sections #578

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

Merged
merged 7 commits into from
Dec 19, 2022
Merged

Move special cases to notes sections #578

merged 7 commits into from
Dec 19, 2022

Conversation

kgryte
Copy link
Contributor

@kgryte kgryte commented Dec 19, 2022

This PR

  • resolves Reorganize documentation to display parameters and return values more prominently #518 (and as discussed in Tracking issue for specification maintenance tasks #533) whereby special cases should be moved to "Notes" sections.
  • only moves notes directives which explicitly discuss special case behavior; otherwise, other notes concerning other aspects of API behavior were left in place (e.g., when complex conjugation should result in the same output whether conjugating the input or the output, etc).
  • removes special case documentation in the array_object which is documented in existing function API documentation. This addresses duplication and maintainability concerns.
  • adds two commits to the .git-blame-ignore-revs file in order to retain Git blame for documented special cases.
  • a follow-up PR based on the changes introduced in this PR will be submitted to add C99 branch cut notes.

Notes

  • Only 2 of the 3 substantive commits were added to the .git-blame-ignore-revs file. The omitted commit should not be included in the list of ignored commits as the changes are not simply reorganization and should be tracked via Git blame.
  • This PR should be merged with a merge commit, rather than squash-merged, in order for the commit hashes in the .git-blame-ignore-revs file to be correct.

@kgryte kgryte added the Maintenance Bug fix, typo fix, or general maintenance. label Dec 19, 2022
@kgryte kgryte added this to the v2022 milestone Dec 19, 2022
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks @kgryte. I went through the rendered version of everything (I think), and found two issues. There's more to do on this topic, but let's leave that until a later time (after tagging v2022.12).

@kgryte
Copy link
Contributor Author

kgryte commented Dec 19, 2022

@rgommers Thanks for reviewing and catching atan and floor_divide. Those issues should now be addressed.

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

LGTM now, in it goes.

@rgommers rgommers merged commit b9acf42 into main Dec 19, 2022
@rgommers rgommers deleted the add-notes-sections branch December 19, 2022 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Bug fix, typo fix, or general maintenance.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize documentation to display parameters and return values more prominently
2 participants