Skip to content

Conversation

@MTwem
Copy link
Contributor

@MTwem MTwem commented Jan 7, 2026

This update addresses issues raised in #697 :

"https://rubicon-objc.beeware.org/en/latest/reference/rubicon-objc-types/#rubicon.objc.types.register_preferred_encoding there's ":func:register_encoding" reference instead of linked correctly.

Also NSEdgeInsetsMake at https://rubicon-objc.beeware.org/en/latest/reference/rubicon-objc-types/#rubicon.objc.types.NSEdgeInsetsMake is missing a docstring.

@johnzhou721 johnzhou721 mentioned this pull request Jan 7, 2026
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Thanks for this update; a couple of notes inline, in addition to the pre-commit issue that CI has flagged.

Copy link
Member

Choose a reason for hiding this comment

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

The change note isn't the same thing as a commit message - it's the content that will be put into the final release notes. That means it needs to be in a voice of "Rubicon now has long awaited shiny new feature!" or "Rubicon no longer breaks on Tuesday afternoons".

In this case, it probably doesn't even rate a release note - although this is a change to documentation, it's a relative minor bugfix/tweak, not something is an important update that someone upgrading should know about.

To that end - this file should:

  1. Be named 697.misc.md
  2. Only include the text "Some minor errors in ObjC type documentation were resolved.".

Comment on lines 973 to 976
"""Create and return an ``NSEdgeInsets`` with the given values.
Parameters
----------
Copy link
Member

Choose a reason for hiding this comment

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

The docstring for other ...Make() methods is indicative here. We don't need to declare parameters (and if we did, we would use Sphinx notation); and the reference to NSEdgeInserts should be a cross-reference, not a RST literal.

@MTwem MTwem requested a review from freakboy3742 January 8, 2026 05:07
@MTwem
Copy link
Contributor Author

MTwem commented Jan 8, 2026

Comments actioned. Ready for review

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Tere was one last pre-commit issue caused by a trailing space on a line; I've corrected that, and tests have now passed. Thanks for the PR!

@freakboy3742 freakboy3742 merged commit 875b49a into beeware:main Jan 8, 2026
18 checks passed
@MTwem
Copy link
Contributor Author

MTwem commented Jan 8, 2026

Hooray! My first issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants