Search Results

Search found 10963 results on 439 pages for 'documentation generation'.

Page 48/439 | < Previous Page | 44 45 46 47 48 49 50 51 52 53 54 55  | Next Page >

  • What to put in a python module docstring?

    - by 007brendan
    Ok, so I've read both PEP 8 and PEP 257, and I've written lots of docstrings for functions and classes, but I'm a little unsure about what should go in a module docstring. I figured, at a minimum, it should document the functions and classes that the module exports, but I've also seen a few modules that list author names, copyright information, etc. Does anyone have an example of how a good python docstring should be structured?

    Read the article

  • Generating changelogs from commit-comments - bad idea?

    - by Adam Asham
    I work for a small company (<10 developers) where we use Svn and to some extent Git. We have no release system implemented. We don't tag our applications with a release numbers so as you can imagine, we don't keep track of changes between releases very well. With this in mind I've been thinking about generating changelogs from the commit-comments. It doesn't have to be an awful idea if you implement guidelines for how to write comments. Or am I fooling myself thinking that colleagues will follow these guidelines? Most of them don't bother adding comments today but I'm hoping that will change if they become aware of how to formulate themselves and that you don't have to comment on every single commit. Or would we it be more wise to gather information from our bug/project managing software and write the changelogs manually (which unfortunately is something nobody wants to do)?

    Read the article

  • What is the proper way to credit public code snippets?

    - by Babiker
    This question might not be a programming problem, but its been bothering me. There is a lot of free js/css scripts out there for public use. I some times use these scripts. If any, what is the formal and proper way to credit these snippets when all i have is a name of a website and a url. I understand that a simple comment might get the job done but i wanted to know whether there is a more professional way.

    Read the article

  • what standards i should follow?

    - by moon
    i know it is not a programming related question but pretty much relate to IT field. i have to write a user manual for my product, and i am searching for a standard from last three days but i didn't find any useful information, can anyone guide me what standards exists there for this purpose (User Manual Writing ) , if there are some good suggestions that will also help me! thanx

    Read the article

  • Documents needed for software development process

    - by Jibu P C
    Hii, I am new to architectural designing of the applications, and our company is not following any procedures and we are not documenting any thing regarding the software development. So can anybody help me to understand regarding the above context. If you find any useful articles links please forward me.

    Read the article

  • Tips for documenting a web application?

    - by Pandiya Chendur
    I know that I can take my asp.net application and get it reversed to a UML document, but that doesn't tell the whole story of things like who can use what, what it calls in the way of stored procedures, what pages call what pages etc. etc. Does anyone know of an article where someone has a comprehensive way to document a web application/site? Or shall I just make up my own way?

    Read the article

  • Document key usage in Dictionary

    - by phq
    How can I document the key usage in a Dictionary so that it shows in Visual studio when coding using that object? I'm looking for something like: /// <param name="SpecialName">That Special Name</param> public Dictionary<string,string> bar; So far the best attempt has been to write my own class: public class SpecialNameDictionary : IDictionary<string, string> { private Dictionary<string, string> data = new Dictionary<string, string>(); /// <param name="specialName">That Special Name</param> public string this[string specialName] { get { return data[specialName]; } } } But It adds a lot of code that doesn't do anything. Additionally I must retype every Dictionary method to make it compile. Is there a better way to achive the above?

    Read the article

  • How to make maintaince document for a website?

    - by metal-gear-solid
    How to make maintenance document for a website? I've created a site using XHTML ,CSS, jQuery etc. it's big site. Now i have to write a maintenance document for a site for if any changes comes in future related to design, content and functionality then those things will be handled by someone else. How and what should i keep in maintenance document.

    Read the article

  • What should "Solution Architecture" document describe ?

    - by anjanb
    We're going to build a Solution which includes acquiring data through mobile phones(J2ME) and laptops(browser based data acquisition), uploading the same data to back-end servers(built with J2EE) and then analyzing the same data including generating various types of reports. This solution will include a CMS for building the website and various interfaces for various types of users. I'm to do a "Solutions Architecture" document for the same. What should that document consist of ? Are there any templates (WORD, .ODT, .PDF) ? Any inputs appreciated. Thank you so much,

    Read the article

  • Is there a programmatic way to transform a sequence of image files into a PDF?

    - by Salim Fadhley
    I have a sequence of JPG images. Each of the scans is already cropped to the exact size of one page. They are sequential pages of a valuable and out of print book. The publishing application requires that these pages be submitted as a single PDF file. I could take each of these images and just past them into a word-processor (e.g. OpenOffice) - unfortunately the problem here is that it's a very big book and I've got quite a few of these books to get through. It would obviously be time-consuming. This is volunteer work! My second idea was to use LaTeX - I could make a very simple document that consists of nothing more than a series of in-line image includes. I'm sure that this approach could be made to work, it's just a little on the complex side for something which seems like a very simple job. It occurred to me that there must be a simpler way - so any suggestions? I'm on Ubuntu 9.10, my primary programming language is Python, but if the solution is super-simple I'd happily adopt any technology that works.

    Read the article

  • Modelling in Agile Development

    - by bertzzie
    I'm writing a bachelor dissertation report where I'm developing a system with Agile methodology. Given that the development is an one man show, of course the "Agile" I did was not really agile at all (from my understanding at least). So I want some perspective from SO crowds, who is of course a professional, real world, developer with tons of experience. I think real world experience is better than the theory and experiments that I did. My question is: Do we model during development time when using Agile? UML? DFD? Or a Functional Specification is enough1? If modelling is not really necessary, what do we use to communicate to the user, as the user almost always won't understand UML or DFD? For my system, I use UI & UX Design with heavy prototyping, but then I don't have time to draw UML any more. Which one is better? 1 http://www.joelonsoftware.com/articles/fog0000000036.html I hope the question's not "subjective and argumentative" as I know this question exist because of my lack of understanding in the agile development. If it is, could someone just give me a pointer or reference about that? Possible duplicate: Do you use UML in Agile development practices?

    Read the article

  • Is there a network diagram standard for illustrating web services?

    - by Phil.Wheeler
    I'm putting together a Solution Architecture document for an enhancement we're adding to our site and it occurs to me that I've never formally illustrated a web service call before. Is there a convention for how web service calls are illustrated on your garden-variety network diagram? Can anyone point me to examples or share something on Create.ly (or similar service)?

    Read the article

  • Documenting a Access Application for Developers

    - by Nitrodist
    I need to document a MS-Access application that was created, developed and maintained completely by a power-user over 10 years. This is an interesting situation because what they want is a manual so that a future developer can come in without prior domain knowledge and make changes to the frontend or the backend in a timely manner. There are a few questions on my mind for this little project: What is a good manual design creating application? Microsoft Word doesn't quite cut it. What kind of things would you, the developer, need to know in order to make changes to things like forms, reports, tables or other Access objects? Anything else I missed? Any pitfalls?

    Read the article

  • Handover document for complete systems

    - by viraptor
    Hi, I need to create a handover document for a fairly large system consisting of all the stuff you'd expect from a telecom deployment: many servers, database clusters which copy some data between them in specific ways, tons of log files, both off-the-shelf and locally developed software, scripts, network configurations, local know-how, etc. It's really got as many sysadmin-typical elements, as development ones. The target of this document are in the first place sysadmins who take over the day-to-day operation tasks and some problem resolving, and in the second place people who want to learn about the system in general. Is there some place I can learn about how to write something like that? It could just as easily be a 10 page "what's where", as a 500 pages book about "all things telephony". Maybe it should be more than one document really. Please link some useful resources / books I could use for this task. PS: this is intended to be internal only, customer interactions etc. are out of scope here

    Read the article

  • Finding What You Need in R: function arguments/parameters from outside the function's package

    - by doug
    Often in R, there are a dozen functions scattered across as many packages--all of which have the same purpose but of course differ in accuracy, performance, theoretical rigor, and so on. How do you gather all of these in one place before you start your task? So for instance: the generic plot function. Setting secondary ticks is much easier (IMHO) using a function outside of the base package, minor.tick(nx=n, ny=n, tick.ratio=n), found in Hmisc. Of course, that doesn't show up in plot's docstring. Likewise, the data-input arguments to 'plot' can be supplied by an object returned from the function 'hexbin', again, from a library outside of the base installation (where 'plot' resides). What would be great obviously is a programmatic way to gather these function arguments from the various libraries and put them in a single namespace. edit: (trying to re-state my example just above more clearly:) the arguments to plot supplied in the base package for, e.g., setting the axis tick frequency are xaxp/yaxp; however, one can also set a/t/f via a function outside of the base package, again, as in the minor.tick function from the Hmisc package--but you wouldn't know that just from looking at the plot method signature. Is there a meta function in R for this? So far, as i come across them, i've been manually gathering them in a TextMate 'snippet' (along with the attendant library imports). This isn't that difficult or time consuming, but i can only update my snippet as i find out about these additional arguments/parameters. Is there a canonical R way to do this, or at least an easier way? Just in case that wasn't clear, i am not talking about the case where multiple packages provide functions directed to the same statistic or view (e.g., 'boxplot' in the base package; 'boxplot.matrix' in gplots; and 'bplots' in Rlab). What i am talking is the case in which the function name is the same across two or more packages.

    Read the article

  • Excluding items from TOC in Sphinx (documenter)?

    - by Spot
    I'm using sphinx to document our internal API. For each class we're listing methods and then sub-sections under each such as Description and Examples, etc. The Table of Contents is generated automatically in the sidebar, which is great except that it lists all the sub-sections. I am looking for a way to tell Sphinx to ignore certain headings when generating the TOC. I have scoured the docs but have not found what I need. I'm sure it's something I missed. Some advice will be appreciated. Thanks.

    Read the article

  • How do I find out what android system icons mean?

    - by The Trav
    Ok, so I've got an andoid phone with a bunch of icons up the top, looks like app notifications go on the left, system icons go on the right. Most of the system icons seem reasonably intuitive, service, 3g, wireless etc. I've recently gotten a new one that looks like a phone being tilted / shaken and have absolutely no idea what it means. Is there a reference site where I can look this thing up?

    Read the article

  • Is there a definitive list of uri patterns for use in android apps made by google?

    - by The Trav
    Apart from http://developer.android.com/guide/appendix/g-app-intents.html (which is quite good but fairly limited in the number of apps/uri's it covers) I've been unable to find a decent reference source for looking up URI's to use when integrating with google apps. I'm currently working on triggering the "add new contact" UI, and have found that the tel: uri pattern seems to work, but what if I only have a name and an email? I wouldn't have expected I'd need to rely on sample code / trial and error, but I really can't see anywhere where the intent/URI interface is supposed to be documented in android apps. Does such a standard exist? Is there some quasi standard / user database that I can consult? On a platform with such a good inter-interoperability architecture it just seems like something so useful I can't believe it's not there

    Read the article

< Previous Page | 44 45 46 47 48 49 50 51 52 53 54 55  | Next Page >