Originally, Object Oriented Programming talks about encapsulation which means hiding all your detailed logic behind a class such that the user can only care about the application level of the function rather than trying to understand all the inner workings.
However, usually, many smaller libraries or examples/framework in assignment made by professors did a poor job to describe how the function really works, nor they have provided any meaningful example about the input of the functions, ending up doing the opposite of what encapsulation originally has claimed which the developer have to look into the implementation or even the whole program just to understand what the function really do.
However, usually, many smaller libraries or examples/framework in assignment made by professors did a poor job to describe how the function really works, nor they have provided any meaningful example about the input of the functions, ending up doing the opposite of what encapsulation originally has claimed which the developer have to look into the implementation or even the whole program just to understand what the function really do.
Example 1: Damn, I am sick of this assignment about building AI agent for a Pacman Game where there is no clear documentation about how every classes works. How can I suppose to know all the properties and expected return data without looking into their encrapsulated agent classes?
Example 2: ("Coming Soon" in the documentation) Oh no... there is no documentation about this highly confusing python function over this confusing input parameter "something". Welp, it is time to find the source code of this encrapsulation to see what type it I should use.
Example 2: ("Coming Soon" in the documentation) Oh no... there is no documentation about this highly confusing python function over this confusing input parameter "something". Welp, it is time to find the source code of this encrapsulation to see what type it I should use.
by IllegalArgumentException May 26, 2025