Skip to content

UDL Style guide #22

Description

@taruma

Buat panduan development/style guide.

Tutorial Development Guide

Panduan untuk pengembangan LAMBDA seperti:

  • Instalasi AFE 1.1.
  • Navigasi menggunakan AFE 1.1.
  • Troubleshooting LAMBDA dengan AFE 1.1.

UDL Style Guide

Panduan penulisan kode User-Defined LAMBDA (UDL):

  • Selalu beri komentar pada setiap fungsi dependencies yang digunakan seperti FUNGSI_YANG_DIGUNAKAN --> FUNGSI_YANG_DIKEMBANGKAN. Atau jika tidak memiliki ketergantungan, bisa menuliskan NONE --> FUNGSI_YANG_DIKEMBANGKAN.
  • Memberi nama fungsi yang jelas, jika merupakan fungsi yang melakukan sesuatu, gunakan kata kerja seperti ambil GET, ubah dimensi RESHAPE / ARRANGE, dll.
  • Gunakan pemisah underscore untuk setiap katanya.
  • Gunakan huruf besar untuk nama fungsi.
  • Memberi nama variabel yang deskriptif. Hindari nama seperti "_col1", "_array1", gunakan deskripsi seperti "selected_first_column", "array_data".
  • Chunking setiap fungsi.
  • Test development.
  • Hindari menyingkat nama variabel ataupun nama fungsi yang tidak umum.
  • Hindari menggunakan optional argument untuk fungsi pendukung.
  • Fungsi utama harus mendefinisikan ulang untuk optional argument.

Activity

  1. changed the title [-]Development guide[/-] [+]Development and style guide[/+] on Jan 8, 2023
  2. iingLK commented on Jan 9, 2023

    @iingLK
    • Jenis input dan output mungkin perlu disebut.
    • Serta kapan UDL itu bisa lebih baik atau disarankan dibandingkan dengan bawaannya.
  3. changed the title [-]Development and style guide[/-] [+]UDL Style guide[/+] on Jan 9, 2023
  4. taruma commented on Jan 9, 2023

    @taruma
    OwnerAuthor

    updated

  5. added this to the v0.4.0 milestone on Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions