MAINT: deprecate AvailabilityMixin

[bsipocz]

This is to close #214

The class wasn't exposed to the user documentation so it's borderline whether this needs a deprecation and a changelog, but it was part of the modules's __all__, so I treat it as it was part of the public API (as #411 revealed that a few API docs are mistakenly missing from the rendered documentation)

[edit]: it was in fact mentioned in the narrative docs, it was only the API docs that wasn't exposed. So I've now removed that narrative, too.

[codecov]

Codecov Report

Merging #413 (c32f563) into main (eb24f44) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #413      +/-   ##
==========================================
+ Coverage   79.92%   79.93%   +0.01%     
==========================================
  Files          52       52              
  Lines        6011     6016       +5     
==========================================
+ Hits         4804     4809       +5     
  Misses       1207     1207              

Impacted Files	Coverage Δ
pyvo/dal/vosi.py	69.64% <100.00%> (+1.41%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[msdemlei]

Excellent, thanks a lot.

(and: made a note to configure my vi to swallow trailing blanks, although the ones in this diff by and large weren't mine).

[bsipocz]

While sleeping on it I realised that this won't be sufficient as is, users won't come across this deprecation warning as they are not directly using the base class, but they face the missing properties as I removed subclassing this for the services.

cc @plim in case she can recall of a precent of deprecating a base class, so I can follow an already used recipe.

Otherwise I'll plan to add back the subclassing during the deprecation period and deprecate the individual inherited parts hoping not to pepper the users with unnecessary warnings, but also make them a chance to see those.

ps: I'm sorry about the trailing whitespaces, I haven't noticed that my editor touched on those when I made the commit, it wasn't my intention to do any such cleanups here.

[bsipocz]

This should now be done properly, e.g. keeping the properties inherited from the AvailabiltyMixin base class deprecated rather than being removed straight away.

[msdemlei]

Thanks for tackling this!

I've briefly considered whether I'd do a trailing-whitespace-eating commit first to make this diff a bit tidier, but interestingly this is about the last file with trailing blanks in docs (and in the source code, there's just a few XML files left), so I think it's ok to let that cleanup in with this otherwise harmless commit.