Missing docstrings (CLE)

[zardus]

There are lots of missing module, class, and function docstrings in the angr module. Here is the list. We desperately need help with this from the community, if someone wants to contribute!

Here is the list:

************* Module cle.errors
- errors.py:1 - 
************* Module cle.memory
- memory.py:1 - 
- memory.py:42 - Clemory.update_backer
- memory.py:53 - Clemory.remove_backer
- memory.py:193 - Clemory._stride_repr
************* Module cle.backends.idabin
- backends/idabin.py:1 - 
- backends/idabin.py:324 - IDABin.plt
- backends/idabin.py:329 - IDABin.reverse_plt
- backends/idabin.py:332 - IDABin.get_call_stub_addr
- backends/idabin.py:336 - IDABin.is_ppc64_abiv1
************* Module cle.backends.cgc
- backends/cgc.py:1 - 
- backends/cgc.py:33 - CGC.make_elf_copy
************* Module cle.backends.metaelf
- backends/metaelf.py:1 - 
- backends/metaelf.py:21 - MetaELF._block
- backends/metaelf.py:29 - MetaELF._add_plt_stub
- backends/metaelf.py:39 - MetaELF._load_plt
- backends/metaelf.py:93 - MetaELF._load_plt.tick
- backends/metaelf.py:98 - MetaELF._load_plt.scan_forward
************* Module cle.backends.backedcgc
- backends/backedcgc.py:1 - 
- backends/backedcgc.py:5 - FakeSegment
- backends/backedcgc.py:66 - BackedCGC.initial_register_values
************* Module cle.backends.blob
- backends/blob.py:1 - 
************* Module cle.backends.elfcore
- backends/elfcore.py:1 - 
- backends/elfcore.py:78 - ELFCore.initial_register_values
************* Module cle.backends.elf
- backends/elf.py:1 - 
- backends/elf.py:47 - ELFSegment.is_readable
- backends/elf.py:51 - ELFSegment.is_writable
- backends/elf.py:55 - ELFSegment.is_executable
- backends/elf.py:59 - ELFSection
- backends/elf.py:89 - ELFSection.occupies_memory
- backends/elf.py:97 - ELFSection.is_strings
- backends/elf.py:241 - ELF._extract_init_fini
- backends/elf.py:287 - ELF.__register_segments
- backends/elf.py:300 - ELF._rebase_addr
- backends/elf.py:416 - ELF.__register_relocs
- backends/elf.py:466 - ELF._make_reloc
- backends/elf.py:474 - ELF.__register_tls
- backends/elf.py:480 - ELF.__register_sections
- backends/elf.py:497 - ELF.__register_section_symbols
- backends/elf.py:503 - ELF.__relocate_mips
- backends/elf.py:580 - ELFHashTable.elf_hash
- backends/elf.py:616 - GNUHashTable._matches_bloom
- backends/elf.py:649 - GNUHashTable.gnu_hash
************* Module cle.backends.pe
- backends/pe.py:1 - 
- backends/pe.py:153 - PE._get_jmprel
- backends/pe.py:156 - PE._handle_imports
- backends/pe.py:168 - PE._handle_exports
************* Module cle.backends
- backends/__init__.py:1 - 
- backends/__init__.py:187 - Symbol.resolve
- backends/__init__.py:363 - Backend.set_arch
- backends/__init__.py:370 - Backend.entry
- backends/__init__.py:404 - Backend.addr_to_offset
- backends/__init__.py:410 - Backend.offset_to_addr
************* Module cle.relocations.ppc
- relocations/ppc.py:1 - 
************* Module cle.relocations.ppc64
- relocations/ppc64.py:1 - 
- relocations/ppc64.py:7 - R_PPC64_JMP_SLOT
************* Module cle.relocations.arm64
- relocations/arm64.py:1 - 
************* Module cle.relocations.generic
- relocations/generic.py:1 - 
- relocations/generic.py:7 - GenericAbsoluteReloc
- relocations/generic.py:12 - GenericAbsoluteAddendReloc
- relocations/generic.py:17 - GenericJumpslotReloc
- relocations/generic.py:25 - GenericRelativeReloc
- relocations/generic.py:34 - GenericCopyReloc
- relocations/generic.py:39 - GenericTLSModIdReloc
- relocations/generic.py:50 - GenericTLSDoffsetReloc
- relocations/generic.py:59 - GenericTLSOffsetReloc
- relocations/generic.py:70 - GenericIRelativeReloc
- relocations/generic.py:82 - MipsGlobalReloc
- relocations/generic.py:85 - MipsLocalReloc
************* Module cle.relocations.armel
- relocations/armel.py:1 - 
************* Module cle.relocations.arm
- relocations/arm.py:1 - 
************* Module cle.relocations.armhf
- relocations/armhf.py:1 - 
************* Module cle.relocations.i386
- relocations/i386.py:1 - 
- relocations/i386.py:16 - R_386_PC32
************* Module cle.relocations.amd64
- relocations/amd64.py:1 - 
************* Module cle.relocations.mips
- relocations/mips.py:1 - 
************* Module cle.relocations
- relocations/__init__.py:1 - 
- relocations/__init__.py:15 - load_relocations
- relocations/__init__.py:43 - get_relocation
- relocations/__init__.py:82 - Relocation.addend
- relocations/__init__.py:88 - Relocation.resolve_symbol
- relocations/__init__.py:111 - Relocation.resolve
- relocations/__init__.py:118 - Relocation.rebased_addr
- relocations/__init__.py:122 - Relocation.dest_addr
- relocations/__init__.py:126 - Relocation.value
************* Module cle.relocations.mips64
- relocations/mips64.py:1 - 
************* Module cle.tls
- tls.py:1 - 
- tls.py:29 - roundup
- tls.py:62 - TLSObj.finalize
- tls.py:65 - TLSObj.finalize.drop
- tls.py:68 - TLSObj.finalize.drop_int
- tls.py:96 - TLSObj.thread_pointer
************* Module cle.loader
- loader.py:1 - 
- loader.py:127 - Loader.linux_loader_object
- loader.py:143 - Loader._load_main_binary
- loader.py:163 - Loader._load_dependencies
- loader.py:270 - Loader.get_loader_symbolic_constraints
- loader.py:344 - Loader._possible_paths
- loader.py:371 - Loader._perform_reloc
- loader.py:385 - Loader.provide_symbol
- loader.py:429 - Loader.addr_belongs_to_object
- loader.py:793 - Loader.all_elf_objects
- loader.py:796 - Loader.perform_irelative_relocs
************* Module cle
- __init__.py:1 - 

[github-actions[bot]]

This issue has been marked as stale because it has no recent activity. Please comment or add the pinned tag to prevent this issue from being closed.