Improve documentation of JoinFeature

[soehms]

As observed in #34282 (see comment 28 ff there) there are two different use cases of this class which need to be explained in the doc-string.

Component: documentation

Keywords: join feature

Author: Sebastian Oehms

Branch/Commit: 68d4fe2

Reviewer: Kwankyu Lee

Issue created by migration from https://trac.sagemath.org/ticket/34508

[soehms]

Branch: u/soehms/docu_join_feature_34508

[soehms]

New commits:

a4768fa

34508: initial

[soehms]

Commit: a4768fa

[soehms]

Author: Sebastian Oehms

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

ff38871	Merge branch 'u/soehms/docu_join_feature_34508' of trac.sagemath.org:sage into docu_join_feature_34508
23d9d6c	34508: typo

[sagetrac-git]

Changed commit from a4768fa to 23d9d6c

[kwankyu]

Changed branch from u/soehms/docu_join_feature_34508 to u/klee/docu_join_feature_34508

[kwankyu]

Changed commit from 23d9d6c to 68d4fe2

[kwankyu]

comment:5

I made minor edits. In particular, I removed the link to the ticket since the docstring summarizes important points of the discussion in the ticket. (I don't like links to trac tickets in our documentation except obviously necessary cases.)

If you are okay, you can set positive-review.

---

New commits:

68d4fe2

Some edits

[kwankyu]

Reviewer: Kwankyu Lee

[soehms]

comment:7

Replying to Kwankyu Lee:

I made minor edits. In particular, I removed the link to the ticket since the docstring summarizes important points of the discussion in the ticket. (I don't like links to trac tickets in our documentation except obviously necessary cases.)

I don't like them in parts of the reference manual dedicated to end users, either. But here I didn't mind about it.

If you are okay, you can set positive-review.

Anyway, I'm fine with your changes. Thank you!

[kwankyu]

comment:8

Replying to Sebastian Oehms:

I don't like them (links to trac tickets) in parts of the reference manual dedicated to end users, either.

Exactly. In this case, end users are developers :)

Anyway, I'm fine with your changes. Thank you!

Thanks!

[vbraun]

Changed branch from u/klee/docu_join_feature_34508 to 68d4fe2