Skip to content

Rename some functions to help beginners navigate source code #326

Closed
@findmyway

Description

@findmyway

I only realize this problem very recently. Multiple dispatch seems to be overused here in this package. For example, the update! function. I thought it was quite straightforward. When we want to update a policy during interactions with environments, we collect all the necessary information and then narrow them down layer by layer. Just like peeling the onions. And update!(x, y, z...) is usually read as please update x given y and z. Unfortunately different implementations are split accross many different files, which makes it hard for beginners to understand the code structure.

So before we have a smarter IDE to jump between such function calls, we'd better name them more clearly.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions