Update Docu #636
Update Docu #636
Conversation
… The changes were made in the wrong file. This reverts commit 50e885f.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #636 +/- ##
=======================================
Coverage 71.19% 71.19%
=======================================
Files 55 55
Lines 5946 5946
=======================================
Hits 4233 4233
Misses 1713 1713 ☔ View full report in Codecov by Sentry. |
| restore step (none, linear or tukey). Defaults to "tukey". | ||
| clean_restored_output (CleanRestoredOutputType): Type of restored image output: | ||
| taylor, list, or integrated. Defaults to "list". | ||
| :param imaging_npixel: see ImageCleanerConfig |
There was a problem hiding this comment.
Is there a specific reason to change the docstring format here? Switching to a unified docstring format and checking the format on-commit is an open issue, but this would require a fair amount of work.
| Might be useful for reading larger-than-memory .fits files. | ||
| memmap: Whether to use memory mapping when opening the FITS file. | ||
| Allows for reading of larger-than-memory files. | ||
| :param fits_file: The .fits file to create the sky-model from. |
There was a problem hiding this comment.
Reason for docstring format change? (see comment above)
|
|
||
| Returns: | ||
| .tm file-path & station-name conversion (e.g. station055 -> station009) | ||
| """ |
There was a problem hiding this comment.
Reason for docstring format change? (see above)
| @@ -117,7 +117,7 @@ def detect_sources_in_image( | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| cls : Type[_SourceDetectionResultType] | |||
| cls : Type[SourceDetectionResultType] | |||
There was a problem hiding this comment.
Should be reverted, refers to _SourceDetectionResultType defined on line 258
| Additional keyword arguments to pass to PyBDSF.process_image function. | ||
|
|
||
| Returns | ||
| ------- | ||
| Optional[List[_SourceDetectionResultType]] | ||
| Optional[List[SourceDetectionResultType]] |
There was a problem hiding this comment.
Should be reverted, refers to _SourceDetectionResultType defined on line 258
This pull request updates the documentation. Three things were done or fixed:
Karabo.imagingmodule.