pmelchior / scarlet

This says See ~init_sources but should say init_source:

Line 336 in 134fac6

See `~init_sources` for a description of the arguments

This says "Fraction of the background to use as a threshold" but should say it is the background RMS, as in ExtendedSource, e.g. say "Multiple of the backround RMS used as a flux cutoff for morphology initialization.":

scarlet/scarlet/initialization.py

Line 434 in 134fac6

Fraction of the background to use as a threshold for

In the docs here https://pmelchior.github.io/scarlet/0-quickstart.html it says

"We can see that this method chooses multiple (here 2) extended components for the first three sources, a single extended component for sources 3 and 5, and compact ones for the rest."

But the outputs don't show any compact sources, only MultiExtendedSource and SingleExtendedSource

Also here, I think this needs clarification for newbies like me.

scarlet/scarlet/initialization.py

Line 446 in 134fac6

min_snr: float

It says "Mininmum SNR per component to accept the source." From talking to fred it is used to determine how many components are accepted, not if the source (object) is accepted. For fallback=True it will not reject the entire source (object), it will reject components that are not at least min_snr, dropping down to components of zero, which implies that it gets initialized as a point source (but perhaps still modeled as an extended source)

Doc bugs