Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

scan the functions for those lacking documentation #10

Open
mmagnuski opened this issue Aug 16, 2014 · 3 comments
Open

scan the functions for those lacking documentation #10

mmagnuski opened this issue Aug 16, 2014 · 3 comments
Labels
docs tidy up
Milestone
v 0.1

Comments

@mmagnuski
Copy link
Owner

Use NOHELPINFO tag-word to mark these functions
mmagnuski added a commit that referenced this issue Aug 16, 2014
@mmagnuski
Added some NOHELPINFO tag-words, worked on help docs etc. Related to #10
f6cef90 
 issue
mmagnuski referenced this issue Aug 16, 2014
@mmagnuski
added NOHELPINFO to some files, modified help info of other files a l…
288f9b6 
…ittle, related to #9
@mmagnuski mmagnuski added this to the v 0.1 milestone Aug 19, 2014
@mmagnuski
Copy link
Owner Author

Files lacking documentation

Currently these files are lacking documentation:

  • 'ICAw_checkfields.m'
  • 'ICAw_copyrec.m'
  • 'ICAw_dipfit.m'
  • 'ICAw_sorter.m'
  • 'eeg_getrej.m'
  • 'ICAw_ep_proc_GUI.m'
  • 'ICAw_gui_choose_chan.m'
  • 'ICAw_gui_epoch.m'
  • 'ICAw_gui_upd_txt.m'
  • 'ICAw_gui_upd_txt2.m'
  • 'gui_chooselist.m'
  • 'gui_editbox.m'
  • 'gui_multiedit.m'
  • 'selcol_GUI.m'
  • 'ICAw_applyrej.m'
  • 'ICAw_newrejtype.m'
  • 'ICAw_nonrej.m'
  • 'ICAw_rejICAw2EEG.m'
  • 'ICAw_rejTMP.m'
  • 'ICAw_rem_marks.m'
  • 'ICAw_scanrejtypes.m'
  • 'ICAw_addversion.m'
  • 'ICAw_bringversion.m'
  • 'ICAw_mainversion.m'
  • 'ICAw_vers_compare.m'
  • 'ICAw_scan4patterns.m'
  • 'ICAw_tag_search.m'
  • 'check_dipfit_status.m'
  • 'comment_search.m'
  • 'listTaggedFuncs.m'

@mmagnuski
Copy link
Owner Author

Thesre is now a howto on listing files by tag keyword like FIXHELPINFO.

@mmagnuski
Copy link
Owner Author

  • create an early sketch of build_doc.py or build_doc.m that scans docstrings of all the .m functions and reports FIXHELPINFO, NOHELPINFO etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs tidy up
Projects
None yet
Milestone
v 0.1
Development

No branches or pull requests
1 participant
@mmagnuski