search

oasis-open / cti-python-stix2

OASIS TC Open Repository: Python APIs for STIX 2
https://stix2.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
356 stars 113 forks source link

`CustomExtension` documentation refers to old observable type specific behaviour #518

Closed maybe-sybr closed 2 years ago

maybe-sybr commented 2 years ago

Since #468 got merged today, I've been looking into the changes so I can work out what changes I need to make to my customs to be ready for 3.0. I noticed that the user guide section of the doco for dev extensions proposal [0] still appears to describe the old way of creating CustomExtensions with up to 3 args. The relevant change is the removal of the observable_type argument since extensions can be applied to any object now IIUC.

The latest doco also has the old style code in the user guide, but also has the wrong arguments for CustomExtension in the API docs so I'm guessing it hasn't been rebuilt yet.

[0] https://stix2.readthedocs.io/en/dev-extensions-proposal/guide/custom.html#Custom-Cyber-Observable-Extensions

https://github.com/oasis-open/cti-python-stix2/blob/17170e65d1502259b247dfa641fae4d55b8047fc/docs/guide/custom.ipynb#L1580-L1591

maybe-sybr commented 2 years ago

This got fixed in #520 , closing