Fix docstring :param: names that do not match the signatures - #69966
Fix docstring :param: names that do not match the signatures#69966darkdi wants to merge 1 commit into
Conversation
twangboy
left a comment
There was a problem hiding this comment.
Please make these changes against the earliest supported branch where the problem exists. 3006.x most likely.
76774d4 to
edeed6c
Compare
|
Retargeted to One entry did not come across: Everything else is identical. |
|
The remaining one might be in 3007.x or 3008.x |
|
It is in all three: 3007.x, 3008.x and master carry So 3007.x is the earliest branch where it exists. I will send it there once this one lands, as a one-line change rather than bundling it here. |
What does this PR do?
Twenty-six
:param:fields name something the callable does not take. Docstrings only — no code, no behaviour, no tests.Thirteen are renames:
_filter_dict(napalm_network)search_valuessearch_valuediff(rpm_lowpkg)packagepackage_pathget_jids_filter(local_cache)filter_find_jobsfilter_find_job_purge_jobs(pgjsonb)job_age_in_secondstimestampTCPPuller.__init__socket_pathpath_lookup_dnspythonserverserverscaa_rec,mx_rec,srv_recrdatardatasstate_docs,module_docs(baredoc)namenamesAESFuncs._handle_aesloaddatais_reachable_hosthostnameentity_nameTwo had the field itself malformed rather than misnamed:
Master.__init__has:param dict: The salt options— a type with no name, so Sphinx renders a parameter calleddict. It isopts.LoadedFunchas:param func str:— the type and name are the wrong way round, and neither matches: the argument isname.LoadedCoroinherits__init__and carries the same line, so both are corrected.The rest document an argument that is simply gone:
keep_loopinget_local_client,functionsinauth,runnersinstates,settingsinbcache.device,paramsincql_query,tags_regexin_check_pending,srcanddstinapply_template,is_filein_add_dependency, andextra_modsandso_modsinthin.gte, which takes nothing at all. Where a:type:line accompanied the entry, it went with it.One I left alone: the
Wildcardclass docstring inzypperpkgdocuments:param ptn:and:return:, which belong to__call__, not to__init__. Moving them is a restructure rather than a name fix, so that is your call.Every entry was opened and read against its signature.
black --checkflags the same four files before and after this change, so nothing here is new.