closes #10456: test and fix for sphinx.domain.python.filter_meta_fields()

[akruis]

Feature or Bugfix

• Bugfix

Purpose

• Fix autodoc documentation with more that a single meta-field (i.e. :meta prublic: together with :meta hide-value:)

Detail

• Test removal of meta-fields
• Fix the faulty filter function

Relates

• sphinx.domain.python.filter_meta_fields fails to remove more than one meta-field from a field_list #10456

[AA-Turner]

Could you explain why we need reversed and not just for ... in fields[:]:?

A

[tk0miya]

Thanks! It must be merged into the 5.0.0 release. So I'll move the CHANGES entry to 5.0.0 from now on.

[akruis]

Could you explain why we need reversed and not just for ... in fields[:]:?

A

Without reversed the code would be more or less equivalent to

i=0
while i < len(fields):
  field = fields[i]
  if some_condition(field):
    del fields[i]
  i += 1

(Unfortunately this equivalence is a bit obfuscated. At runtime fields is node.) Now, if the code deletes field i, then the index of all following fields changes by -1 and if you increment i by one, you skip one field in the iteration.