[Doc] Unclarity in provided example for package_id method

[ytsarko]

Hello!

Currently the way package_id() method is documented leads to a confusion: why package_id method of recipe returns some inner function called 'package_id '? Just for the clarity, this is the current definition of package_id method on the documentation page:

def package_id(self):
    def package_id(self):
        if self.package_type == "header-library":
            self.info.clear()
        else:
            self.info.settings.rm_safe("compiler.libcxx")
            self.info.settings.rm_safe("compiler.cppstd")

Please check whether documentation snippet of package_id method doesn't contain any error and if not, what is the intention of returning a reference to the function from package_id method then?

[AbrilRBS]

Hi @ytsarko thanks a lot for your report, this is indeed a typo, and the package_id() method is meant to just be the inner one, something like

def package_id(self):
        if self.package_type == "header-library":
            self.info.clear()
        else:
            self.info.settings.rm_safe("compiler.libcxx")
            self.info.settings.rm_safe("compiler.cppstd")

I'll make sure to fix this for the latest version :)

[ytsarko]

Thank you @AbrilRBS, for quick confirmation!

[ytsarko]

Doc is updated, closing the issue as fixed