티스토리 뷰

Programming basic

docstring 작성법

lluna 2021. 11. 29. 17:35

find_suggestion_videos 메소드의 docstring을 작성

def find_suggestion_videos(self, number_of_suggestions=5):

Google docstring

"""유저에게 추천할 영상을 찾아준다
Parameters:
  number_of_suggestions (int): 추천하고 싶은 영상 수
    (기본값은 5)
    
Returns:
  list: 추천할 영상 주소가 담긴 리스트
"""

reStructuredText (파이썬 공식문서)

"""유저에게 추천할 영상을 찾아준다
    
:param number_of_suggestions: 추천하고 싶은 영상 수
  (기본값은 5)
:type number_of_suggestions: int
:returns: 추천할 영상 주소가 담긴 리스트
:rtype: list
"""

NumPy/SciPy

"""유저에게 추천할 영상을 찾아준다
    
Parameters
----------
number_of_suggestions: int
  추천하고 싶은 영상 수 (기본값은 5)
    
Returns
-------
list 
  추천할 영상 주소가 담긴 리스트
"""
저작자표시 비영리 변경금지

'Programming basic' 카테고리의 다른 글

쿠키, 세션을 보완한 토큰 방식 JWT  (0) 2021.12.14
쿠키, 세션 그리고 디장고 인증(Authentication)  (0) 2021.12.14
HTTP 상태 코드  (0) 2021.10.25
변수 및 식별자 표기법 3가지  (0) 2021.10.20
추상화와 다양한 언어  (0) 2021.10.20
댓글