AdguardTeam / AdguardTeam/deep-override

Add some code documentation

Aberta
#14 0 comentários 0 reações 1 responsável Reivindicada por @theseanl Ver no GitHub
enhancement
Linguagem predominante
TypeScript
Estrelas
15
Forks
8
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

I'd appreciate if you add a comment in the file head describing the logic starting from the entry point (`DeepOverrideHost.addProperty`) and briefly explaining the algorithm.

Something like this:
1. The entry point -- `addProperty`, accepts this and that parameter
2. Then we're building the object state tree for the given path (`buildAbstractStateTree`)
3. Using this tree we're applying the object state and override necessary properties (`applyObjectState`)
4. Etc, etc

This will greatly help the reader to understand the code.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.