metasploit-framework

https://github.com/rapid7/metasploit-framework

Ruby

Metasploit Framework

Msf::DBManager::Note#report_note

Report a Note to the database.  Notes can be tied to a ::Mdm::Workspace, Host, or Service.

opts MUST contain
+:type+::  The type of note, e.g. smb_peer_os

opts can contain
+:workspace+::  the workspace to associate with this Note
+:host+::       an IP address or a Host object to associate with this Note
+:service+::    a Service object to associate with this Note
+:data+::       whatever it is you're making a note of
+:port+::       along with +:host+ and +:proto+, a service to associate with this Note
+:proto+::      along with +:host+ and +:port+, a service to associate with this Note
+:update+::     what to do in case a similar Note exists, see below

The +:update+ option can have the following values:
+:unique+::       allow only a single Note per +:host+/+:type+ pair
+:unique_data+::  like +:uniqe+, but also compare +:data+
+:insert+::       always insert a new Note even if one with identical values exists

If the provided +:host+ is an IP address and does not exist in the
database, it will be created.  If +:workspace+, +:host+ and +:service+
are all omitted, the new Note will be associated with the current
workspace.

Source | Google | Stack overflow

Edit

git clone [email protected]:rapid7/metasploit-framework.git

cd metasploit-framework

open lib/msf/core/db_manager/note.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Msf--DBManager--Note-report_note-for-pr

# Commit to git

git add lib/msf/core/db_manager/note.rbgit commit -m "better docs for Msf::DBManager::Note#report_note"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Msf--DBManager--Note-report_note-for-pr

hub pull-request

# Celebrate!