Skip to content

Commit 08d9754

Browse files
committed
Update api-changes's conversion section with stronger wording
Signed-off-by: Maciej Szulik <[email protected]>
1 parent a324cc8 commit 08d9754

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

contributors/devel/sig-architecture/api_changes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -603,9 +603,9 @@ Given that you have not yet changed the internal structs, this might feel
603603
premature, and that's because it is. You don't yet have anything to convert to
604604
or from. We will revisit this in the "internal" section. If you're doing this
605605
all in a different order (i.e. you started with the internal structs), then you
606-
should jump to that topic below. In the very rare case that you are making an
607-
incompatible change you might or might not want to do this now, but you will
608-
have to do more later. The files you want are
606+
should jump to [that topic below](#edit-version-conversions). In the very rare
607+
case that you are making an incompatible change you might or might not want to
608+
do this now, but you will have to do more later. The files you want are
609609
`pkg/apis/<group>/<version>/conversion.go` and
610610
`pkg/apis/<group>/<version>/conversion_test.go`.
611611

@@ -670,7 +670,7 @@ those manually written should be named with a defined convention, i.e. a
670670
function converting type `X` in pkg `a` to type `Y` in pkg `b`, should be named:
671671
`convert_a_X_To_b_Y`.
672672

673-
Also note that you can (and for efficiency reasons should) use auto-generated
673+
**Note:** You should, for efficiency reasons and future updates, use auto-generated
674674
conversion functions when writing your conversion functions.
675675

676676
Adding manually written conversion also requires you to add tests to

0 commit comments

Comments
 (0)